diff options
Diffstat (limited to 'doc')
59 files changed, 524 insertions, 991 deletions
diff --git a/doc/how_to_release.md b/doc/how_to_release.md index 04fb88bd..bc7ce6ce 100644 --- a/doc/how_to_release.md +++ b/doc/how_to_release.md @@ -1,4 +1,4 @@ -# How to release (draft) +# How to release This is a guide for taurus release managers: it details the steps for making an official release, including a checklist @@ -12,27 +12,33 @@ of stuff that should be manually tested. 4. Create the release branch if it was not done already in the previous step and: 1. Review and update the CHANGELOG.md if necessary. See [this](http://keepachangelog.com) 2. Bump version using `bumpversion <major|minor|patch>` (use [semver](http://semver.org/) criteria to choose amongst `major`, `minor` or `patch` - 3. Update man pages: - ``` - cd <taurus>/doc - ./makeman - git add man - git commit -m "Update man pages" - ``` - 4. Create a PR to merge the `release-XXX` against the **`master`** branch of the taurus-org repo + 3. Create a PR to merge the `release-XXX` against the **`master`** branch of the taurus-org repo 5. Request reviews in the PR from at least one integrator from each participating institute. The master branch is protected, so the reviews need to be cleared (or dismissed with an explanation) before the release can be merged. 6. Perform manual tests (see checklist below). You may use the CI artifacts (e.g., from appveyor). To avoid spamming the PR comments with the manual test results, a new issue can be created to report the tests results on each platform (and just use a single check for each platform in the PR). 7. Once all reviews a cleared, update the date of the release in the CHANGELOG.md, run `bumpversion release`, push and merge the PR and tag in master -8. Merge also the `release-XXX` branch into develop, and bump the version of develop with `bumpversion patch` -9. Release to PyPI **from a clean checkout** and using [twine](https://github.com/pypa/twine): - ``` - cd /tmp - git clone https://github.com/taurus-org/taurus.git -b <RELEASE_TAG> - cd taurus - python setup.py sdist bdist_wheel - twine upload dist/* - ``` - +8. Check that travis-ci correctly uploaded to PyPI (triggered on tag push). + + Previously: + ~~Release to PyPI **from a clean checkout** and using [twine](https://github.com/pypa/twine):~~ + > ``` + > cd /tmp + > git clone https://github.com/taurus-org/taurus.git -b <RELEASE_TAG> + > cd taurus + > python setup.py sdist bdist_wheel + >twine upload dist/* + > ``` + +9. Merge also the `release-XXX` branch into develop, and bump the version of develop with `bumpversion patch` +10. Complete GitHub release (upload artifacts, edit text) +11. Create news in www.tango-controls.org + 1. On the News page click on Submit a news and fill up the form (if it doesn't work, try opening in new tab): + * Title: New Release Of Taurus X.X.X (Jan|JulXX) + * Ilustration: Taurus official logo (use png) + * Summary: short summary of the news (do not include the whole changelog here..) + * Categories: Release + 2. After submitting click on Modify this content text of the area \<\<Content\>\> and provide detailes of the release e.g. changelog. +12. Notify mailing lists (taurus-users@lists.sourceforge.net, taurus-devel@lists.sourceforge.net, info@tango-controls.org) + ## Manual test checklist @@ -44,83 +50,60 @@ and access to a Tango system with the TangoTest DS running. Hint: this list can be used as a template to be copy-pasted on an issue linked from the release PR ``` ### Installation -- [ ] Install Taurus from the tar.gz : `pip install <tarball_artifact_URL>` -### Taurusdemo +For tips on how to prepare an environment for installation, see +http://taurus-scada.org/users/getting_started.html + + +- [ ] Install Taurus from the an artifact of Appveyor (tgz or msi): `pip install <tarball_artifact_URL>` +- [ ] Install taurus-pyqtgraph from the master branch of its repo: + `pip install https://github.com/taurus-org/taurus_pyqtgraph/archive/master.zip`. +- [ ] Check installed version of taurus: `taurus --version` +- [ ] Check installed version of taurus_pyqtgraph: `taurus tpg --version` -- [ ] Test all of the buttons of the taurusdemo. All demos should launch correctly and without raising exceptions +### taurus demo + +- [ ] Execute `taurus demo` +- [ ] Test all of the buttons of the taurus demo. All demos should launch correctly and without raising exceptions - [ ] For TaurusLabel, check foreground role, the background role, the prefix, the suffix, the formatter, etc. - [ ] For TaurusLabel, in order to test the background role=value, you can use the following attribute: `eval:["FAULT","ON","OFF","ALARM"][randint(4)]` -- [ ] For TaurusLabel, use a model with fragment (e.g., `sys/tg_test/1/ampli#rvalue.magnitude`, `eval:Q('1mm')#rvalue.unit"`, `eval:10*arange(9)#rvalue[3:4]`) +- [ ] For TaurusLabel, use a model with fragment (e.g., `sys/tg_test/1/ampli#rvalue.magnitude`, `eval:Q('1mm')#rvalue.units`, `eval:10*arange(9)#rvalue[3:4]`) - [ ] For LCD: Test the foreground roles and the background role - [ ] For Led: Test the colors, ON color, Off color. (hint: you can use `eval:False` as a model for testing) -### taurusplot -(basically try all features described in the [user's guide](http://taurus-scada.org/en/latest/users/ui/index.html) +### taurus guiqwt image -- [ ] Execute: `taurusplot "eval:Q(rand(333),'mm')" sys/tg_test/1/wave` -- [ ] Check region Zoom in and out with region zoom and go back stacked zoom levels with the mouse middle button -- [ ] Check mouse wheel Zoom -- [ ] Test panning (dragging with CTRL pressed) -- [ ] Test inspector mode -- [ ] Test pause mode -- [ ] Move curves between axes by clicking on legend (and test zoom on Y2) -- [ ] Test plot configuration dialog -- [ ] Test changing curve titles -- [ ] Test Save & restore config (change curve properties, zoom, etc & check that everything is restored) -- [ ] Open the "Input data selection" dialog and add/remove/reorder /edit models -- [ ] export one curve data to ASCII and then load it using "Input data selection" -> raw data -> open file -- [ ] ... other features from [user's guide](http://taurus-scada.org/en/latest/users/ui/index.html) +- [ ] Execute `taurus guiqwt image --demo` +- [ ] try to resize the image and pan it using the mouse. +- [ ] check the cross section tools, the color maps, etc. +- [ ] replace the image using the "Change Taurus Model" button (choose , eg, sys/tg_test/1/double_image_ro) -### taurustrend -(basically try all features described in the [user's guide](http://taurus-scada.org/en/latest/users/ui/index.html) +### taurus guiqwt trend2d -- [ ] Execute: `taurustrend "eval:Q(rand(),'mm')" sys/tg_test/1/ampli` -- [ ] Execute: `taurustrend -xe "eval:Q(rand(),'mm')" sys/tg_test/1/ampli` -- [ ] Check region Zoom in and out with region zoom and go back stacked zoom levels with the mouse middle button -- [ ] Check mouse wheel Zoom -- [ ] Test panning (dragging with CTRL pressed) -- [ ] Test inspector mode -- [ ] Test pause mode -- [ ] Move curves between axes by clicking on legend (and test zoom on Y2) -- [ ] Test plot configuration dialog -- [ ] Test Forced reading mode -- [ ] Test autopanning mode -- [ ] Test autoscale x mode -- [ ] Test Save & restore config (change curve properties, zoom, etc & check that everything is restored) -- [ ] ... other features from [user's guide](http://taurus-scada.org/users/ui/index.html) - -### Test taurusimage - -- [ ] Execute `taurusimage --demo` -- [ ] try to resize the image and move it using the mouse. +- [ ] Execute: `taurus --polling-period 333 guiqwt trend2d --demo` +- [ ] Execute: `taurus --polling-period 333 guiqwt trend2d -xt --demo` **(known to fail in 4.1.0)** +- [ ] Execute: `taurus --polling-period 333 guiqwt trend2d -xe --demo` +- [ ] Test auto-scroll and auto-scale tools (from context menu) -### taurustrend2d - -- [ ] Execute: `taurustrend2d --demo --taurus-polling-period 333` -- [ ] Execute: `taurustrend2d -xt --demo --taurus-polling-period 333` **(known to fail in 4.1.0)** -- [ ] Execute: `taurustrend2d -xe --demo --taurus-polling-period 333` -- [ ] Test auto-scroll and auto-scale tools -- [ ] Test Save & restore config (change axes range, zoom, tool status colormap etc & check that everything is restored) - -### taurusdesigner -- [ ] Check that taurusdesigner is correctly opened and taurus widgets are present in the catalog +### taurus designer +- [ ] Execute `taurus designer`. Check that the taurus widgets are present in the catalog - [ ] Create an empty widget and drag various taurus widgets to it (they should be correctly dropped) -### taurusdevicepanel -- [ ] Execute: `taurusdevicepanel sys/tg_test/1` +### taurus device +- [ ] Execute: `taurus device sys/tg_test/1` - [ ] Check that it opens correctly and that the attrs and commands are populated - [ ] Execute SwitchStates command (see that the state label changes to FAULT and its color to red) and then execute the Init command and the label returns to RUNNING (blue) - -### tauruspanel -- [ ] Execute: `tauruspanel` + +### taurus panel +- [ ] Execute: `taurus panel` - [ ] Navigate in the tree and select the TangoTest device (the attr an command panels should be populated) +- [ ] Execute SwitchStates command to put it in FAULT, close the GUI and reopen it. Repeat previous point again. -### taurusform +### taurus form (basically try all features described in the [user's guide](http://taurus-scada.org/users/ui/index.html) -- [ ] Launch `taurusform sys/tg_test/1/short_scalar` +- [ ] Launch `taurus form sys/tg_test/1/short_scalar` - [ ] go to label context menu, change the configuration and set range to (-1000, 1000), alarm to (-500, 500) and unit to `mm`. Close the form and relaunch. The new units should be used. Change the the write value and check that the orange color is used when in warning values, and that the write widget does not allow to write values out of range. - [ ] Test to drag and drop of this attribute onto the same form many times (4 times) (If it crashes, you are seeing bug #96) @@ -135,31 +118,94 @@ Hint: this list can be used as a template to be copy-pasted on an issue linked f - [ ] Test the different "show" buttons (tables, images, spectra) - [ ] Change the write widget of double_scalar by a TaurusWheelEdit - [ ] Change other read and write widgets +- [ ] After the previous changes, you should have a quite "custom" form. Use "Save current Settings" and save + to "tf.pck". Close the form and reopen it with `taurus form --config tf.pck` - [ ] ... other features from [user's guide](http://taurus-scada.org/users/ui/index.html) -### taurusgui +### taurus gui (basically try all features described in the [user's guide](http://taurus-scada.org/users/ui/index.html) -- [ ] Launch `taurusgui example01` +- [ ] Launch `taurus gui example01` - [ ] Test (un)lock view - [ ] Create a new panel (a TaurusForm) and drag and drop several models from other forms - [ ] Move panels around (with view unlocked!) and hide ("close") and re-show them - [ ] Test saving and restoring perspectives -- [ ] Test drag&drop from a form to a trend +- [ ] Test drag&drop from a form to a trend (won't work if using the tpg.TaurusTrend, until [this](https://github.com/taurus-org/taurus_pyqtgraph/issues/25)) is fixed +- [ ] Test drag&drop from a form to a plot - [ ] Test clicking on "example01 synoptic" elements and check that the panels raised - [ ] Test that selecting a panel changes the selection on "example01 synoptic" - [ ] Test the actions in the menus -- [ ] Create a new TaurusGui (call it `foogui`) with `taurusgui --new-gui` (follow the wizard) +- [ ] Create a new TaurusGui (call it `foogui`) with `taurus newgui` (follow the wizard) - [ ] Install `foogui` with pip (using a virtualenv may be a good idea) - [ ] launch `foogui` using the script that has been installed - [ ] ... other features from [user's guide](http://taurus-scada.org/users/ui/index.html) +### taurus config +- [ ] Open an ini file with taurus config and check that it is loaded correctly. -### taurusconfigbrowser -- [ ] Open an ini file with taurusconfigbrowser and check that it is loaded correctly. - -### taurusiconcatalog -- [ ] Launch `taurusiconcatalog`. Several tabs with an array of icons [should be displayed](http://taurus-scada.org/en/latest/devel/icon_guide.html#taurus-icon-catalog) +### taurus icons catalog +- [ ] Launch `taurus icons`. Several tabs with an array of icons [should be displayed](http://taurus-scada.org/en/latest/devel/icon_guide.html#taurus-icon-catalog) - [ ] Check that tooltips give info on each icon - [ ] Click on some icons and check that they give a bigger view of the icon and more info. + +### taurus tpg plot (needs taurus_pyqtgraph installed) +- [ ] Execute: `taurus tpg plot "eval:Q(rand(333),'mm')" sys/tg_test/1/wave` +- [ ] Check zoom / panning (drag with right / left button), and Use (A) button to auto-range +- [ ] Test inspector tool +- [ ] Move curves between axes by using the plot configuration option in context menu +- [ ] With curves in Y1 and Y2, test zooms and panning on separate axes (drag with right/left on the axis) +- [ ] Test plot configuration dialog +- [ ] Test changing curve titles +- [ ] Open the "Input data selection" dialog and add/remove/reorder/edit models. Try adding models both for X and Y +- [ ] NOT YET READY <s>Test Save & restore config (change curve properties, zoom, etc & check that everything is restored)</s> + +### taurus tpg trend (needs taurus_pyqtgraph installed) +- [ ] Execute: `taurus tpg trend "eval:Q(rand(),'mm')" sys/tg_test/1/ampli` +- [ ] Execute: `taurus tpg trend -xe "eval:Q(rand(),'mm')" sys/tg_test/1/ampli` +- [ ] Check zoom / panning (drag with right / left button), and Use (A) button to auto-range +- [ ] Test inspector tool +- [ ] Move curves between axes by using the plot configuration option in context menu +- [ ] With curves in Y1 and Y2, test zooms and panning on separate axes (drag with right/left on the axis) +- [ ] Test plot configuration dialog +- [ ] Test Forced reading tool +- [ ] Test Fixed Range Scale tool +- [ ] Test autoscale x mode +- [ ] NOT YET READY <s> Test Save & restore config (change curve properties, zoom, etc & check that everything is restored)</s> + +### taurus qwt5 plot _Only if using py2 qt4_ +(basically try all features described in the [user's guide](http://taurus-scada.org/en/latest/users/ui/index.html) + +- [ ] Execute: `taurus qwt5 plot "eval:Q(rand(333),'mm')" sys/tg_test/1/wave` +- [ ] Check region Zoom in and out with region zoom and go back stacked zoom levels with the mouse middle button +- [ ] Check mouse wheel Zoom +- [ ] Test panning (dragging with CTRL pressed) +- [ ] Test inspector mode +- [ ] Test pause mode +- [ ] Move curves between axes by clicking on legend (and test zoom on Y2) +- [ ] Test plot configuration dialog +- [ ] Test changing curve titles +- [ ] Test Save & restore config (change curve properties, zoom, etc & check that everything is restored) +- [ ] Open the "Input data selection" dialog and add/remove/reorder /edit models +- [ ] export one curve data to ASCII and then load it using "Input data selection" -> raw data -> open file + (Note: make sure to select the X colum as 0) +- [ ] ... other features from [user's guide](http://taurus-scada.org/en/latest/users/ui/index.html) + +### taurus qwt5 trend _Only if using py2 qt4_ +(basically try all features described in the [user's guide](http://taurus-scada.org/en/latest/users/ui/index.html) + +- [ ] Execute: `taurus qwt5 trend "eval:Q(rand(),'mm')" sys/tg_test/1/ampli` +- [ ] Execute: `taurus qwt5 trend -xn "eval:Q(rand(),'mm')" sys/tg_test/1/ampli` +- [ ] Check region Zoom in and out with region zoom and go back stacked zoom levels with the mouse middle button +- [ ] Check mouse wheel Zoom +- [ ] Test panning (dragging with CTRL pressed) +- [ ] Test inspector mode +- [ ] Test pause mode +- [ ] Move curves between axes by clicking on legend (and test zoom on Y2) +- [ ] Test plot configuration dialog +- [ ] Test Forced reading mode +- [ ] Test autopanning mode +- [ ] Test autoscale x mode +- [ ] Test Save & restore config (change curve properties, zoom, etc & check that everything is restored) +- [ ] ... other features from [user's guide](http://taurus-scada.org/users/ui/index.html) + ``` diff --git a/doc/makeman b/doc/makeman index 9bba9cf8..51ac4d68 100755 --- a/doc/makeman +++ b/doc/makeman @@ -50,6 +50,8 @@ for f in `ls` V=`./$f --version 2>/dev/null |egrep -o '[0-9]+.[0-9]+(.[0-9])?'` echo help2man -N -o "$DOCDIR/man/$f.1" --version-string=$V ./$f help2man -N -o "$DOCDIR/man/$f.1" --version-string=$V ./$f + # scripts are installed with 755 permissions, but manpages should be 644 + chmod 644 "$DOCDIR/man/$f.1" done cd $DOCDIR diff --git a/doc/man/taurus.1 b/doc/man/taurus.1 new file mode 100644 index 00000000..16b73ac1 --- /dev/null +++ b/doc/man/taurus.1 @@ -0,0 +1,21 @@ +.TH TAURUS 1 +.SH NAME +taurus \- Taurus command line interface +.SH SYNOPSIS +.TP +\fBtaurus\fP [\fIoptions\fP] [\fIsubcommand\fP [\fIsuboptions\fP] [\fIargs\fP] ... ] +.SH OVERVIEW +Taurus is a python framework for control and data acquisition CLIs and +GUIs in scientific/industrial environments. + +The \fBtaurus\fP command is the main CLI access to launch Taurus +tools. It uses subcommands (e.g. `form', `gui', ...) to provide +functionality. + +The subcommands can be dynamically provided by plugins, so the best +source for information about the available options and subcommands is +to run `taurus --help`. Each subcommand will also provide more detailed help +about its own options and arguments if run as `taurus <command> --help` + +For more information about the Taurus project, visit +http://taurus-scada.org. diff --git a/doc/man/taurusconfigbrowser.1 b/doc/man/taurusconfigbrowser.1 deleted file mode 100644 index e1ed971f..00000000 --- a/doc/man/taurusconfigbrowser.1 +++ /dev/null @@ -1,42 +0,0 @@ -.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.4. -.TH TAURUSCONFIGBROWSER "1" "July 2018" "taurusconfigbrowser 4.4.0" "User Commands" -.SH NAME -taurusconfigbrowser \- manual page for taurusconfigbrowser 4.4.0 -.SH SYNOPSIS -.B taurusconfigbrowser -[\fI\,options\/\fR] [\fI\,INIFILENAME\/\fR] -.SH DESCRIPTION -taurus configuration editor -.SH OPTIONS -.TP -\fB\-h\fR, \fB\-\-help\fR -show this help message and exit -.TP -\fB\-\-version\fR -show program's version number and exit -.IP -Taurus Options: -.IP -Basic options present in any taurus application -.TP -\fB\-\-taurus\-log\-level\fR=\fI\,LEVEL\/\fR -taurus log level. Allowed values are (case -insensitive): critical, error, warning/warn, info, -debug, trace -.TP -\fB\-\-taurus\-polling\-period\fR=\fI\,MILLISEC\/\fR -taurus global polling period in milliseconds -.TP -\fB\-\-taurus\-serialization\-mode\fR=\fI\,SERIAL\/\fR -taurus serialization mode. Allowed values are (case -insensitive): serial, concurrent (default) -.TP -\fB\-\-tango\-host\fR=\fI\,TANGO_HOST\/\fR -Tango host name (either HOST:PORT or a Taurus URI, -e.g. tango://foo:1234) -.TP -\fB\-\-remote\-console\-port\fR=\fI\,PORT\/\fR -enables remote debugging using the given port -.TP -\fB\-\-default\-formatter\fR=\fI\,FORMATTER\/\fR -Override the default formatter diff --git a/doc/man/tauruscurve.1 b/doc/man/tauruscurve.1 deleted file mode 100644 index 8094d70b..00000000 --- a/doc/man/tauruscurve.1 +++ /dev/null @@ -1,48 +0,0 @@ -.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.4. -.TH TAURUSCURVE "1" "July 2018" "tauruscurve 4.4.0" "User Commands" -.SH NAME -tauruscurve \- manual page for tauruscurve 4.4.0 -.SH SYNOPSIS -.B tauruscurve -[\fI\,options\/\fR] [\fI\,<model1> \/\fR[\fI\,<model2>\/\fR] ...] -.SH DESCRIPTION -a taurus application for plotting 1D data sets -.SH OPTIONS -.TP -\fB\-h\fR, \fB\-\-help\fR -show this help message and exit -.TP -\fB\-\-demo\fR -show a demo of the widget -.TP -\fB\-\-window\-name\fR=\fI\,WINDOW_NAME\/\fR -Name of the window -.TP -\fB\-\-version\fR -show program's version number and exit -.IP -Taurus Options: -.IP -Basic options present in any taurus application -.TP -\fB\-\-taurus\-log\-level\fR=\fI\,LEVEL\/\fR -taurus log level. Allowed values are (case -insensitive): critical, error, warning/warn, info, -debug, trace -.TP -\fB\-\-taurus\-polling\-period\fR=\fI\,MILLISEC\/\fR -taurus global polling period in milliseconds -.TP -\fB\-\-taurus\-serialization\-mode\fR=\fI\,SERIAL\/\fR -taurus serialization mode. Allowed values are (case -insensitive): serial, concurrent (default) -.TP -\fB\-\-tango\-host\fR=\fI\,TANGO_HOST\/\fR -Tango host name (either HOST:PORT or a Taurus URI, -e.g. tango://foo:1234) -.TP -\fB\-\-remote\-console\-port\fR=\fI\,PORT\/\fR -enables remote debugging using the given port -.TP -\fB\-\-default\-formatter\fR=\fI\,FORMATTER\/\fR -Override the default formatter diff --git a/doc/man/taurusdemo.1 b/doc/man/taurusdemo.1 deleted file mode 100644 index 6831abb2..00000000 --- a/doc/man/taurusdemo.1 +++ /dev/null @@ -1,42 +0,0 @@ -.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.4. -.TH TAURUSDEMO "1" "July 2018" "taurusdemo 1.0" "User Commands" -.SH NAME -taurusdemo \- manual page for taurusdemo 1.0 -.SH SYNOPSIS -.B taurusdemo -[\fI\,options\/\fR] -.SH DESCRIPTION -A demo application for taurus -.SH OPTIONS -.TP -\fB\-h\fR, \fB\-\-help\fR -show this help message and exit -.TP -\fB\-\-version\fR -show program's version number and exit -.IP -Taurus Options: -.IP -Basic options present in any taurus application -.TP -\fB\-\-taurus\-log\-level\fR=\fI\,LEVEL\/\fR -taurus log level. Allowed values are (case -insensitive): critical, error, warning/warn, info, -debug, trace -.TP -\fB\-\-taurus\-polling\-period\fR=\fI\,MILLISEC\/\fR -taurus global polling period in milliseconds -.TP -\fB\-\-taurus\-serialization\-mode\fR=\fI\,SERIAL\/\fR -taurus serialization mode. Allowed values are (case -insensitive): serial, concurrent (default) -.TP -\fB\-\-tango\-host\fR=\fI\,TANGO_HOST\/\fR -Tango host name (either HOST:PORT or a Taurus URI, -e.g. tango://foo:1234) -.TP -\fB\-\-remote\-console\-port\fR=\fI\,PORT\/\fR -enables remote debugging using the given port -.TP -\fB\-\-default\-formatter\fR=\fI\,FORMATTER\/\fR -Override the default formatter diff --git a/doc/man/taurusdesigner.1 b/doc/man/taurusdesigner.1 deleted file mode 100644 index 370c3e8c..00000000 --- a/doc/man/taurusdesigner.1 +++ /dev/null @@ -1,22 +0,0 @@ -.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.4. -.TH TAURUSDESIGNER "1" "July 2018" "taurusdesigner 4.4.0" "User Commands" -.SH NAME -taurusdesigner \- manual page for taurusdesigner 4.4.0 -.SH SYNOPSIS -.B taurusdesigner -[\fI\,options\/\fR] \fI\,<ui file(s)>\/\fR -.SH DESCRIPTION -The Qt designer application customized for taurus -.SH OPTIONS -.TP -\fB\-\-version\fR -show program's version number and exit -.TP -\fB\-h\fR, \fB\-\-help\fR -show this help message and exit -.TP -\fB\-\-taurus\-path\fR=\fI\,TAURUSPATH\/\fR -additional directories to look for taurus widgets -.TP -\fB\-\-qt\-designer\-path\fR=\fI\,PYQTDESIGNERPATH\/\fR -additional directories to look for python qt widgets diff --git a/doc/man/taurusdevicepanel.1 b/doc/man/taurusdevicepanel.1 deleted file mode 100644 index 6117f9df..00000000 --- a/doc/man/taurusdevicepanel.1 +++ /dev/null @@ -1,45 +0,0 @@ -.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.4. -.TH TAURUSDEVICEPANEL "1" "July 2018" "taurusdevicepanel 4.4.0" "User Commands" -.SH NAME -taurusdevicepanel \- manual page for taurusdevicepanel 4.4.0 -.SH SYNOPSIS -.B taurusdevicepanel -[\fI\,options\/\fR] [\fI\,devname \/\fR[\fI\,attrs\/\fR]] -.SH DESCRIPTION -Taurus Application inspired in Jive and Atk Panel -.SH OPTIONS -.TP -\fB\-h\fR, \fB\-\-help\fR -show this help message and exit -.TP -\fB\-\-config\-file\fR=\fI\,CONFIG_FILE\/\fR -load a config file (TODO: document this option) -.TP -\fB\-\-version\fR -show program's version number and exit -.IP -Taurus Options: -.IP -Basic options present in any taurus application -.TP -\fB\-\-taurus\-log\-level\fR=\fI\,LEVEL\/\fR -taurus log level. Allowed values are (case -insensitive): critical, error, warning/warn, info, -debug, trace -.TP -\fB\-\-taurus\-polling\-period\fR=\fI\,MILLISEC\/\fR -taurus global polling period in milliseconds -.TP -\fB\-\-taurus\-serialization\-mode\fR=\fI\,SERIAL\/\fR -taurus serialization mode. Allowed values are (case -insensitive): serial, concurrent (default) -.TP -\fB\-\-tango\-host\fR=\fI\,TANGO_HOST\/\fR -Tango host name (either HOST:PORT or a Taurus URI, -e.g. tango://foo:1234) -.TP -\fB\-\-remote\-console\-port\fR=\fI\,PORT\/\fR -enables remote debugging using the given port -.TP -\fB\-\-default\-formatter\fR=\fI\,FORMATTER\/\fR -Override the default formatter diff --git a/doc/man/taurusform.1 b/doc/man/taurusform.1 deleted file mode 100644 index 0fd99c92..00000000 --- a/doc/man/taurusform.1 +++ /dev/null @@ -1,48 +0,0 @@ -.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.4. -.TH TAURUSFORM "1" "July 2018" "taurusform 4.4.0" "User Commands" -.SH NAME -taurusform \- manual page for taurusform 4.4.0 -.SH SYNOPSIS -.B taurusform -[\fI\,options\/\fR] [\fI\,model1 \/\fR[\fI\,model2 \/\fR...]] -.SH DESCRIPTION -the taurus form panel application -.SH OPTIONS -.TP -\fB\-h\fR, \fB\-\-help\fR -show this help message and exit -.TP -\fB\-\-window\-name\fR=\fI\,WINDOW_NAME\/\fR -Name of the window -.TP -\fB\-\-config\fR=\fI\,CONFIG_FILE\/\fR, \fB\-\-config\-file\fR=\fI\,CONFIG_FILE\/\fR -use the given config file for initialization -.TP -\fB\-\-version\fR -show program's version number and exit -.IP -Taurus Options: -.IP -Basic options present in any taurus application -.TP -\fB\-\-taurus\-log\-level\fR=\fI\,LEVEL\/\fR -taurus log level. Allowed values are (case -insensitive): critical, error, warning/warn, info, -debug, trace -.TP -\fB\-\-taurus\-polling\-period\fR=\fI\,MILLISEC\/\fR -taurus global polling period in milliseconds -.TP -\fB\-\-taurus\-serialization\-mode\fR=\fI\,SERIAL\/\fR -taurus serialization mode. Allowed values are (case -insensitive): serial, concurrent (default) -.TP -\fB\-\-tango\-host\fR=\fI\,TANGO_HOST\/\fR -Tango host name (either HOST:PORT or a Taurus URI, -e.g. tango://foo:1234) -.TP -\fB\-\-remote\-console\-port\fR=\fI\,PORT\/\fR -enables remote debugging using the given port -.TP -\fB\-\-default\-formatter\fR=\fI\,FORMATTER\/\fR -Override the default formatter diff --git a/doc/man/taurusgui.1 b/doc/man/taurusgui.1 deleted file mode 100644 index 8f0694b7..00000000 --- a/doc/man/taurusgui.1 +++ /dev/null @@ -1,54 +0,0 @@ -.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.4. -.TH TAURUSGUI "1" "July 2018" "taurusgui 4.4.0" "User Commands" -.SH NAME -taurusgui \- manual page for taurusgui 4.4.0 -.SH SYNOPSIS -.B taurusgui -[\fI\,options\/\fR] \fI\,confname\/\fR -.SH DESCRIPTION -The taurus GUI application -.SH OPTIONS -.TP -\fB\-h\fR, \fB\-\-help\fR -show this help message and exit -.TP -\fB\-\-config\-dir\fR=\fI\,CONFIG_DIR\/\fR -use the given configuration directory for -initialization -.TP -\fB\-\-new\-gui\fR -launch a wizard for creating a new TaurusGUI -application -.TP -\fB\-\-fail\-proof\fR -launch in fail proof mode (it prevents potentially -problematic configs from being loaded) -.TP -\fB\-\-version\fR -show program's version number and exit -.IP -Taurus Options: -.IP -Basic options present in any taurus application -.TP -\fB\-\-taurus\-log\-level\fR=\fI\,LEVEL\/\fR -taurus log level. Allowed values are (case -insensitive): critical, error, warning/warn, info, -debug, trace -.TP -\fB\-\-taurus\-polling\-period\fR=\fI\,MILLISEC\/\fR -taurus global polling period in milliseconds -.TP -\fB\-\-taurus\-serialization\-mode\fR=\fI\,SERIAL\/\fR -taurus serialization mode. Allowed values are (case -insensitive): serial, concurrent (default) -.TP -\fB\-\-tango\-host\fR=\fI\,TANGO_HOST\/\fR -Tango host name (either HOST:PORT or a Taurus URI, -e.g. tango://foo:1234) -.TP -\fB\-\-remote\-console\-port\fR=\fI\,PORT\/\fR -enables remote debugging using the given port -.TP -\fB\-\-default\-formatter\fR=\fI\,FORMATTER\/\fR -Override the default formatter diff --git a/doc/man/taurusiconcatalog.1 b/doc/man/taurusiconcatalog.1 deleted file mode 100644 index f9c04120..00000000 --- a/doc/man/taurusiconcatalog.1 +++ /dev/null @@ -1,40 +0,0 @@ -.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.4. -.TH TAURUSICONCATALOG "1" "July 2018" "taurusiconcatalog 4.4.0" "User Commands" -.SH NAME -taurusiconcatalog \- manual page for taurusiconcatalog 4.4.0 -.SH SYNOPSIS -.B taurusiconcatalog -[\fI\,options\/\fR] -.SH OPTIONS -.TP -\fB\-\-version\fR -show program's version number and exit -.TP -\fB\-h\fR, \fB\-\-help\fR -show this help message and exit -.IP -Taurus Options: -.IP -Basic options present in any taurus application -.TP -\fB\-\-taurus\-log\-level\fR=\fI\,LEVEL\/\fR -taurus log level. Allowed values are (case -insensitive): critical, error, warning/warn, info, -debug, trace -.TP -\fB\-\-taurus\-polling\-period\fR=\fI\,MILLISEC\/\fR -taurus global polling period in milliseconds -.TP -\fB\-\-taurus\-serialization\-mode\fR=\fI\,SERIAL\/\fR -taurus serialization mode. Allowed values are (case -insensitive): serial, concurrent (default) -.TP -\fB\-\-tango\-host\fR=\fI\,TANGO_HOST\/\fR -Tango host name (either HOST:PORT or a Taurus URI, -e.g. tango://foo:1234) -.TP -\fB\-\-remote\-console\-port\fR=\fI\,PORT\/\fR -enables remote debugging using the given port -.TP -\fB\-\-default\-formatter\fR=\fI\,FORMATTER\/\fR -Override the default formatter diff --git a/doc/man/taurusimage.1 b/doc/man/taurusimage.1 deleted file mode 100644 index 150f699e..00000000 --- a/doc/man/taurusimage.1 +++ /dev/null @@ -1,51 +0,0 @@ -.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.4. -.TH TAURUSIMAGE "1" "July 2018" "taurusimage 4.4.0" "User Commands" -.SH NAME -taurusimage \- manual page for taurusimage 4.4.0 -.SH SYNOPSIS -.B taurusimage -[\fI\,options\/\fR] \fI\,<model>\/\fR -.SH DESCRIPTION -a Taurus application for plotting Image Attributes -.SH OPTIONS -.TP -\fB\-h\fR, \fB\-\-help\fR -show this help message and exit -.TP -\fB\-\-demo\fR -show a demo of the widget -.TP -\fB\-\-rgb\fR -assume image is RGB -.TP -\fB\-\-window\-name\fR=\fI\,WINDOW_NAME\/\fR -Name of the window -.TP -\fB\-\-version\fR -show program's version number and exit -.IP -Taurus Options: -.IP -Basic options present in any taurus application -.TP -\fB\-\-taurus\-log\-level\fR=\fI\,LEVEL\/\fR -taurus log level. Allowed values are (case -insensitive): critical, error, warning/warn, info, -debug, trace -.TP -\fB\-\-taurus\-polling\-period\fR=\fI\,MILLISEC\/\fR -taurus global polling period in milliseconds -.TP -\fB\-\-taurus\-serialization\-mode\fR=\fI\,SERIAL\/\fR -taurus serialization mode. Allowed values are (case -insensitive): serial, concurrent (default) -.TP -\fB\-\-tango\-host\fR=\fI\,TANGO_HOST\/\fR -Tango host name (either HOST:PORT or a Taurus URI, -e.g. tango://foo:1234) -.TP -\fB\-\-remote\-console\-port\fR=\fI\,PORT\/\fR -enables remote debugging using the given port -.TP -\fB\-\-default\-formatter\fR=\fI\,FORMATTER\/\fR -Override the default formatter diff --git a/doc/man/tauruspanel.1 b/doc/man/tauruspanel.1 deleted file mode 100644 index ac70730f..00000000 --- a/doc/man/tauruspanel.1 +++ /dev/null @@ -1,42 +0,0 @@ -.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.4. -.TH TAURUSPANEL "1" "July 2018" "tauruspanel 4.4.0" "User Commands" -.SH NAME -tauruspanel \- manual page for tauruspanel 4.4.0 -.SH SYNOPSIS -.B tauruspanel -[\fI\,options\/\fR] [\fI\,devname\/\fR] -.SH DESCRIPTION -Taurus Application inspired in Jive and Atk Panel -.SH OPTIONS -.TP -\fB\-h\fR, \fB\-\-help\fR -show this help message and exit -.TP -\fB\-\-version\fR -show program's version number and exit -.IP -Taurus Options: -.IP -Basic options present in any taurus application -.TP -\fB\-\-taurus\-log\-level\fR=\fI\,LEVEL\/\fR -taurus log level. Allowed values are (case -insensitive): critical, error, warning/warn, info, -debug, trace -.TP -\fB\-\-taurus\-polling\-period\fR=\fI\,MILLISEC\/\fR -taurus global polling period in milliseconds -.TP -\fB\-\-taurus\-serialization\-mode\fR=\fI\,SERIAL\/\fR -taurus serialization mode. Allowed values are (case -insensitive): serial, concurrent (default) -.TP -\fB\-\-tango\-host\fR=\fI\,TANGO_HOST\/\fR -Tango host name (either HOST:PORT or a Taurus URI, -e.g. tango://foo:1234) -.TP -\fB\-\-remote\-console\-port\fR=\fI\,PORT\/\fR -enables remote debugging using the given port -.TP -\fB\-\-default\-formatter\fR=\fI\,FORMATTER\/\fR -Override the default formatter diff --git a/doc/man/taurusplot.1 b/doc/man/taurusplot.1 deleted file mode 100644 index fb2e1ad4..00000000 --- a/doc/man/taurusplot.1 +++ /dev/null @@ -1,60 +0,0 @@ -.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.4. -.TH TAURUSPLOT "1" "July 2018" "taurusplot 4.4.0" "User Commands" -.SH NAME -taurusplot \- manual page for taurusplot 4.4.0 -.SH SYNOPSIS -.B taurusplot -[\fI\,options\/\fR] [\fI\,<model1> \/\fR[\fI\,<model2>\/\fR] ...] -.SH DESCRIPTION -a taurus application for plotting 1D data sets -.SH OPTIONS -.TP -\fB\-h\fR, \fB\-\-help\fR -show this help message and exit -.TP -\fB\-x\fR t|n, \fB\-\-x\-axis\-mode\fR=\fI\,t\/\fR|n -interprete X values as either timestamps (t) or -numbers (n). Accepted values: t|n (e is also accepted -as a synonim of n) -.TP -\fB\-\-config\fR=\fI\,CONFIG_FILE\/\fR, \fB\-\-config\-file\fR=\fI\,CONFIG_FILE\/\fR -use the given config file for initialization -.TP -\fB\-\-import\-ascii\fR=\fI\,IMPORT_ASCII\/\fR -import the given ascii file into the plot -.TP -\fB\-\-export\fR=\fI\,EXPORT_FILE\/\fR, \fB\-\-export\-file\fR=\fI\,EXPORT_FILE\/\fR -use the given file to as output instead of showing the -plot -.TP -\fB\-\-window\-name\fR=\fI\,WINDOW_NAME\/\fR -Name of the window -.TP -\fB\-\-version\fR -show program's version number and exit -.IP -Taurus Options: -.IP -Basic options present in any taurus application -.TP -\fB\-\-taurus\-log\-level\fR=\fI\,LEVEL\/\fR -taurus log level. Allowed values are (case -insensitive): critical, error, warning/warn, info, -debug, trace -.TP -\fB\-\-taurus\-polling\-period\fR=\fI\,MILLISEC\/\fR -taurus global polling period in milliseconds -.TP -\fB\-\-taurus\-serialization\-mode\fR=\fI\,SERIAL\/\fR -taurus serialization mode. Allowed values are (case -insensitive): serial, concurrent (default) -.TP -\fB\-\-tango\-host\fR=\fI\,TANGO_HOST\/\fR -Tango host name (either HOST:PORT or a Taurus URI, -e.g. tango://foo:1234) -.TP -\fB\-\-remote\-console\-port\fR=\fI\,PORT\/\fR -enables remote debugging using the given port -.TP -\fB\-\-default\-formatter\fR=\fI\,FORMATTER\/\fR -Override the default formatter diff --git a/doc/man/taurustestsuite.1 b/doc/man/taurustestsuite.1 deleted file mode 100644 index fac013af..00000000 --- a/doc/man/taurustestsuite.1 +++ /dev/null @@ -1,24 +0,0 @@ -.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.4. -.TH TAURUSTESTSUITE "1" "July 2018" "taurustestsuite 4.4.0" "User Commands" -.SH NAME -taurustestsuite \- manual page for taurustestsuite 4.4.0 -.SH DESCRIPTION -usage: taurustestsuite [\-h] [\-\-skip\-gui\-tests] [\-e EXCLUDE_PATTERN] -.IP -[\-\-version] -.PP -Main test suite for Taurus -.SS "optional arguments:" -.TP -\fB\-h\fR, \fB\-\-help\fR -show this help message and exit -.TP -\fB\-\-skip\-gui\-tests\fR -Do not perform tests requiring GUI -.TP -\fB\-e\fR EXCLUDE_PATTERN, \fB\-\-exclude\-pattern\fR EXCLUDE_PATTERN -regexp pattern matching test ids to be excluded. (e.g. -\&'taurus\e.core\e..*' would exclude taurus.core tests) -.TP -\fB\-\-version\fR -show program's version number and exit diff --git a/doc/man/taurustrend.1 b/doc/man/taurustrend.1 deleted file mode 100644 index e5e581a2..00000000 --- a/doc/man/taurustrend.1 +++ /dev/null @@ -1,67 +0,0 @@ -.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.4. -.TH TAURUSTREND "1" "July 2018" "taurustrend 4.4.0" "User Commands" -.SH NAME -taurustrend \- manual page for taurustrend 4.4.0 -.SH SYNOPSIS -.B taurustrend -[\fI\,options\/\fR] [\fI\,<model1> \/\fR[\fI\,<model2>\/\fR] ...] -.SH DESCRIPTION -a taurus application for plotting trends -.SH OPTIONS -.TP -\fB\-h\fR, \fB\-\-help\fR -show this help message and exit -.TP -\fB\-x\fR t|e, \fB\-\-x\-axis\-mode\fR=\fI\,t\/\fR|e -interprete X values as either timestamps (t) or event -numbers (e). Accepted values: t|e -.TP -\fB\-b\fR MAX_BUFFER_SIZE, \fB\-\-buffer\fR=\fI\,MAX_BUFFER_SIZE\/\fR -maximum number of values per curve to be plotted -(default = 65536) (when reached, the oldest values -will be discarded) -.TP -\fB\-\-config\fR=\fI\,CONFIG_FILE\/\fR, \fB\-\-config\-file\fR=\fI\,CONFIG_FILE\/\fR -use the given config file for initialization -.TP -\fB\-\-export\fR=\fI\,EXPORT_FILE\/\fR, \fB\-\-export\-file\fR=\fI\,EXPORT_FILE\/\fR -use the given file to as output instead of showing the -plot -.TP -\fB\-r\fR MILLISECONDS, \fB\-\-forced\-read\fR=\fI\,MILLISECONDS\/\fR -force Taurustrend to re\-read the attributes every -MILLISECONDS ms -.HP -\fB\-a\fR, \fB\-\-use\-archiving\fR -.TP -\fB\-\-window\-name\fR=\fI\,WINDOW_NAME\/\fR -Name of the window -.TP -\fB\-\-version\fR -show program's version number and exit -.IP -Taurus Options: -.IP -Basic options present in any taurus application -.TP -\fB\-\-taurus\-log\-level\fR=\fI\,LEVEL\/\fR -taurus log level. Allowed values are (case -insensitive): critical, error, warning/warn, info, -debug, trace -.TP -\fB\-\-taurus\-polling\-period\fR=\fI\,MILLISEC\/\fR -taurus global polling period in milliseconds -.TP -\fB\-\-taurus\-serialization\-mode\fR=\fI\,SERIAL\/\fR -taurus serialization mode. Allowed values are (case -insensitive): serial, concurrent (default) -.TP -\fB\-\-tango\-host\fR=\fI\,TANGO_HOST\/\fR -Tango host name (either HOST:PORT or a Taurus URI, -e.g. tango://foo:1234) -.TP -\fB\-\-remote\-console\-port\fR=\fI\,PORT\/\fR -enables remote debugging using the given port -.TP -\fB\-\-default\-formatter\fR=\fI\,FORMATTER\/\fR -Override the default formatter diff --git a/doc/man/taurustrend1d.1 b/doc/man/taurustrend1d.1 deleted file mode 100644 index 32c30ac7..00000000 --- a/doc/man/taurustrend1d.1 +++ /dev/null @@ -1,58 +0,0 @@ -.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.4. -.TH TAURUSTREND1D "1" "July 2018" "taurustrend1d 4.4.0" "User Commands" -.SH NAME -taurustrend1d \- manual page for taurustrend1d 4.4.0 -.SH SYNOPSIS -.B taurustrend1d -[\fI\,options\/\fR] \fI\,<model>\/\fR -.SH DESCRIPTION -a Taurus application for plotting trends of scalars -.SH OPTIONS -.TP -\fB\-h\fR, \fB\-\-help\fR -show this help message and exit -.TP -\fB\-x\fR t|d|e, \fB\-\-x\-axis\-mode\fR=\fI\,t\/\fR|d|e -interpret X values as timestamps (t), time deltas (d) -or event numbers (e). Accepted values: t|d|e -.TP -\fB\-b\fR MAX_BUFFER_SIZE, \fB\-\-buffer\fR=\fI\,MAX_BUFFER_SIZE\/\fR -maximum number of values to be plotted (when reached, -the oldest values will be discarded) -.HP -\fB\-a\fR, \fB\-\-use\-archiving\fR -.TP -\fB\-\-demo\fR -show a demo of the widget -.TP -\fB\-\-window\-name\fR=\fI\,WINDOW_NAME\/\fR -Name of the window -.TP -\fB\-\-version\fR -show program's version number and exit -.IP -Taurus Options: -.IP -Basic options present in any taurus application -.TP -\fB\-\-taurus\-log\-level\fR=\fI\,LEVEL\/\fR -taurus log level. Allowed values are (case -insensitive): critical, error, warning/warn, info, -debug, trace -.TP -\fB\-\-taurus\-polling\-period\fR=\fI\,MILLISEC\/\fR -taurus global polling period in milliseconds -.TP -\fB\-\-taurus\-serialization\-mode\fR=\fI\,SERIAL\/\fR -taurus serialization mode. Allowed values are (case -insensitive): serial, concurrent (default) -.TP -\fB\-\-tango\-host\fR=\fI\,TANGO_HOST\/\fR -Tango host name (either HOST:PORT or a Taurus URI, -e.g. tango://foo:1234) -.TP -\fB\-\-remote\-console\-port\fR=\fI\,PORT\/\fR -enables remote debugging using the given port -.TP -\fB\-\-default\-formatter\fR=\fI\,FORMATTER\/\fR -Override the default formatter diff --git a/doc/man/taurustrend2d.1 b/doc/man/taurustrend2d.1 deleted file mode 100644 index fa4f224b..00000000 --- a/doc/man/taurustrend2d.1 +++ /dev/null @@ -1,58 +0,0 @@ -.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.4. -.TH TAURUSTREND2D "1" "July 2018" "taurustrend2d 4.4.0" "User Commands" -.SH NAME -taurustrend2d \- manual page for taurustrend2d 4.4.0 -.SH SYNOPSIS -.B taurustrend2d -[\fI\,options\/\fR] \fI\,<model>\/\fR -.SH DESCRIPTION -a Taurus application for plotting trends of arrays (aka "spectrograms") -.SH OPTIONS -.TP -\fB\-h\fR, \fB\-\-help\fR -show this help message and exit -.TP -\fB\-x\fR t|d|e, \fB\-\-x\-axis\-mode\fR=\fI\,t\/\fR|d|e -interpret X values as timestamps (t), time deltas (d) -or event numbers (e). Accepted values: t|d|e -.TP -\fB\-b\fR MAX_BUFFER_SIZE, \fB\-\-buffer\fR=\fI\,MAX_BUFFER_SIZE\/\fR -maximum number of values to be stacked (when reached, -the oldest values will be discarded) -.HP -\fB\-a\fR, \fB\-\-use\-archiving\fR -.TP -\fB\-\-demo\fR -show a demo of the widget -.TP -\fB\-\-window\-name\fR=\fI\,WINDOW_NAME\/\fR -Name of the window -.TP -\fB\-\-version\fR -show program's version number and exit -.IP -Taurus Options: -.IP -Basic options present in any taurus application -.TP -\fB\-\-taurus\-log\-level\fR=\fI\,LEVEL\/\fR -taurus log level. Allowed values are (case -insensitive): critical, error, warning/warn, info, -debug, trace -.TP -\fB\-\-taurus\-polling\-period\fR=\fI\,MILLISEC\/\fR -taurus global polling period in milliseconds -.TP -\fB\-\-taurus\-serialization\-mode\fR=\fI\,SERIAL\/\fR -taurus serialization mode. Allowed values are (case -insensitive): serial, concurrent (default) -.TP -\fB\-\-tango\-host\fR=\fI\,TANGO_HOST\/\fR -Tango host name (either HOST:PORT or a Taurus URI, -e.g. tango://foo:1234) -.TP -\fB\-\-remote\-console\-port\fR=\fI\,PORT\/\fR -enables remote debugging using the given port -.TP -\fB\-\-default\-formatter\fR=\fI\,FORMATTER\/\fR -Override the default formatter diff --git a/doc/source/conf.py b/doc/source/conf.py index 63d63c0e..5384947e 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -56,7 +56,8 @@ def _build_doc_api(): auto_rst4api = imp.load_module(name, *data) API_Creator = auto_rst4api.Auto_rst4API_Creator # prepare api creator - excl = ['_[^\.]*[^_]', + excl = ['.*\._[^\.]+[^_]', # exclude private objects + '.*\.(object|zip|str)', # avoid warnings from builtins '.*\.test', 'taurus\.external', 'taurus\.qt\.qtgui\.extra_sardana', @@ -64,11 +65,11 @@ def _build_doc_api(): 'taurus\.qt\.qtgui\.extra_macroexecutor', 'taurus\.qt\.qtgui\.resource', 'taurus\.qt\.qtgui\.taurusgui\.conf', + 'taurus\.qt\.qtgui\.qwt5\.taurusplotconf', # Under Construction ] if sys.version_info.major > 2: excl += [ 'taurus\.qt\.qtgui\.qwt5', # qwt5 not available in PY3 - '.*\.(object|zip|str)', # avoid warnings from builtins ] rstCreator = API_Creator(exclude_patterns=excl, @@ -298,8 +299,8 @@ inheritance_graph_attrs = dict(rankdir="UD", ratio='compress') intersphinx_mapping = { 'python': ('https://docs.python.org/dev', None), - 'numpy': ('http://www.numpy.org', None), + 'numpy': ('https://numpy.org', 'numpy.inv'), # work around err 403 'sardana': ('https://sardana-controls.org', None), - 'pint': ('http://pint.readthedocs.io/en/stable/', None), - 'PyTango': ('http://pytango.readthedocs.io/en/stable/', None), + 'pint': ('https://pint.readthedocs.io/en/stable/', None), + 'PyTango': ('https://pytango.readthedocs.io/en/stable/', None), } diff --git a/doc/source/devel/coding_guide.rst b/doc/source/devel/coding_guide.rst index a6b477d3..67ad6e29 100644 --- a/doc/source/devel/coding_guide.rst +++ b/doc/source/devel/coding_guide.rst @@ -130,6 +130,20 @@ PyQt4, PyQt5 and PySide versions. from taurus.external.qt import QtWebKit from taurus.external.qt import Qwt5 +.. note:: this guideline applies to code which is part of the taurus module or its + plugins. For end-user applications that use taurus, this rule may not apply, + as mentioned in `TEP18`_: + + *For an end-user application based on taurus* it is probably better to import + directly from a specific binding (PyQt5 is the best supported) and let taurus to + adapt to that choice. In this way, one can write idiomatic code that better + matches the chosen binding. Using the ``taurus.external.qt`` shim + is also possible if one wants to make the code binding-agnostic, but in that + case one must keep in mind that the resulting code will be less idiomatic + and that the shim's API may be eventually altered to better fit with taurus + own requirements (and that those changes may not be aligned with the + application needs). + 2. Since Taurus v>=4.0, Qt-based code in Taurus assumes that `PyQt API v2`_ is used. PyQt API 1 code is not accepted in taurus. @@ -208,4 +222,5 @@ PyQt4, PyQt5 and PySide versions. .. _LGPL: http://www.gnu.org/licenses/lgpl.html .. _`PyQt API v2`: http://pyqt.sourceforge.net/Docs/PyQt4/incompatible_apis.html .. _`new-style signals`: http://pyqt.sourceforge.net/Docs/PyQt4/new_style_signals_slots.html -.. _future: https://python-future.org/
\ No newline at end of file +.. _future: https://python-future.org/ +.. _TEP18: http://taurus-scada.org/tep/?TEP18.md diff --git a/doc/source/devel/designer_tutorial.rst b/doc/source/devel/designer_tutorial.rst index 1443543c..aae60de9 100644 --- a/doc/source/devel/designer_tutorial.rst +++ b/doc/source/devel/designer_tutorial.rst @@ -6,13 +6,13 @@ Taurus Qt Designer tutorial Taurus widgets behave just as any other Qt widget, and as such, they can be used to create GUIs in a regular way, both programmatically or using the Qt designer. -For convenience, Taurus provides the `taurusdesigner` command that launches the +For convenience, Taurus provides the `taurus designer` command that launches the standard Qt designer application extended to show also the widgets provided by Taurus. To launch it, just execute:: - taurusdesigner + taurus designer .. tip:: diff --git a/doc/source/devel/examples.rst b/doc/source/devel/examples.rst index 31bfed96..aee0542e 100644 --- a/doc/source/devel/examples.rst +++ b/doc/source/devel/examples.rst @@ -49,7 +49,7 @@ header:: from taurus.external.qt import Qt from taurus.qt.qtgui.application import TaurusApplication - app = TaurusApplication(sys.argv) + app = TaurusApplication(sys.argv, cmd_line_parser=None) panel = Qt.QWidget() layout = Qt.QHBoxLayout() panel.setLayout(layout) @@ -79,7 +79,7 @@ code:: from taurus.external.qt import Qt from taurus.qt.qtgui.application import TaurusApplication - app = TaurusApplication(sys.argv) + app = TaurusApplication(sys.argv, cmd_line_parser=None,) panel = Qt.QWidget() layout = Qt.QHBoxLayout() panel.setLayout(layout) @@ -369,7 +369,7 @@ feature-rich and very configurable GUIs by using existing widgets as "panels". TaurusGuis can be created via a wizard application (no programming at all!) with a few clicks. You can try it out by running:: - taurusgui --new-gui + taurus newgui For more details and tricks regarding TaurusGui, check :ref:`this <taurusgui_newgui>`. diff --git a/doc/source/devel/examples/edit01.py b/doc/source/devel/examples/edit01.py index d3d35e31..57d76848 100644 --- a/doc/source/devel/examples/edit01.py +++ b/doc/source/devel/examples/edit01.py @@ -2,7 +2,7 @@ import sys from taurus.external.qt import Qt from taurus.qt.qtgui.application import TaurusApplication -app = TaurusApplication(sys.argv) +app = TaurusApplication(sys.argv, cmd_line_parser=None) panel = Qt.QWidget() layout = Qt.QHBoxLayout() panel.setLayout(layout) diff --git a/doc/source/devel/examples/edit02.py b/doc/source/devel/examples/edit02.py index cb960cf6..6be264b6 100644 --- a/doc/source/devel/examples/edit02.py +++ b/doc/source/devel/examples/edit02.py @@ -5,7 +5,7 @@ from taurus.qt.qtgui.display import TaurusLabel from taurus.qt.qtgui.input import TaurusValueSpinBox from taurus.qt.qtgui.application import TaurusApplication -app = TaurusApplication(sys.argv) +app = TaurusApplication(sys.argv, cmd_line_parser=None) panel = TaurusWidget() layout = Qt.QHBoxLayout() diff --git a/doc/source/devel/examples/edit03.py b/doc/source/devel/examples/edit03.py index a9776390..f5011381 100644 --- a/doc/source/devel/examples/edit03.py +++ b/doc/source/devel/examples/edit03.py @@ -5,7 +5,7 @@ from taurus.qt.qtgui.display import TaurusLabel from taurus.qt.qtgui.input import TaurusWheelEdit from taurus.qt.qtgui.application import TaurusApplication -app = TaurusApplication(sys.argv) +app = TaurusApplication(sys.argv, cmd_line_parser=None) panel = TaurusWidget() layout = Qt.QHBoxLayout() diff --git a/doc/source/devel/examples/forms01.py b/doc/source/devel/examples/forms01.py index a62aabfc..4cb82416 100644 --- a/doc/source/devel/examples/forms01.py +++ b/doc/source/devel/examples/forms01.py @@ -2,7 +2,7 @@ import sys from taurus.qt.qtgui.panel import TaurusForm from taurus.qt.qtgui.application import TaurusApplication -app = TaurusApplication(sys.argv) +app = TaurusApplication(sys.argv, cmd_line_parser=None) panel = TaurusForm() props = ['state', 'status', 'position', 'velocity', 'acceleration'] diff --git a/doc/source/devel/examples/forms02.py b/doc/source/devel/examples/forms02.py index 3dd1a7fe..67c6cfe5 100644 --- a/doc/source/devel/examples/forms02.py +++ b/doc/source/devel/examples/forms02.py @@ -3,7 +3,7 @@ from taurus.qt.qtgui.panel import TaurusForm from taurus.qt.qtgui.display import TaurusLabel from taurus.qt.qtgui.application import TaurusApplication -app = TaurusApplication(sys.argv) +app = TaurusApplication(sys.argv, cmd_line_parser=None) panel = TaurusForm() props = ['state', 'status', 'position', 'velocity', 'acceleration'] diff --git a/doc/source/devel/examples/label01.py b/doc/source/devel/examples/label01.py index cda00694..5fb71424 100644 --- a/doc/source/devel/examples/label01.py +++ b/doc/source/devel/examples/label01.py @@ -2,7 +2,7 @@ import sys from taurus.external.qt import Qt from taurus.qt.qtgui.application import TaurusApplication -app = TaurusApplication(sys.argv) +app = TaurusApplication(sys.argv, cmd_line_parser=None) panel = Qt.QWidget() layout = Qt.QHBoxLayout() panel.setLayout(layout) diff --git a/doc/source/devel/examples/label02.py b/doc/source/devel/examples/label02.py index f3a5e79c..1339763d 100644 --- a/doc/source/devel/examples/label02.py +++ b/doc/source/devel/examples/label02.py @@ -2,7 +2,7 @@ import sys from taurus.external.qt import Qt from taurus.qt.qtgui.application import TaurusApplication -app = TaurusApplication(sys.argv) +app = TaurusApplication(sys.argv, cmd_line_parser=None) panel = Qt.QWidget() layout = Qt.QHBoxLayout() panel.setLayout(layout) diff --git a/doc/source/devel/examples/label03.py b/doc/source/devel/examples/label03.py index ef3655f3..0f25a64d 100644 --- a/doc/source/devel/examples/label03.py +++ b/doc/source/devel/examples/label03.py @@ -2,7 +2,7 @@ import sys from taurus.external.qt import Qt from taurus.qt.qtgui.application import TaurusApplication -app = TaurusApplication(sys.argv) +app = TaurusApplication(sys.argv, cmd_line_parser=None) panel = Qt.QWidget() layout = Qt.QHBoxLayout() panel.setLayout(layout) diff --git a/doc/source/devel/examples/label04.py b/doc/source/devel/examples/label04.py index cfa5d8f3..1c3c61fe 100644 --- a/doc/source/devel/examples/label04.py +++ b/doc/source/devel/examples/label04.py @@ -4,7 +4,7 @@ from taurus.qt.qtgui.container import TaurusWidget from taurus.qt.qtgui.display import TaurusLabel from taurus.qt.qtgui.application import TaurusApplication -app = TaurusApplication(sys.argv) +app = TaurusApplication(sys.argv, cmd_line_parser=None) panel = TaurusWidget() layout = Qt.QVBoxLayout() panel.setLayout(layout) diff --git a/doc/source/devel/examples/label05.py b/doc/source/devel/examples/label05.py index febd388e..143a9975 100644 --- a/doc/source/devel/examples/label05.py +++ b/doc/source/devel/examples/label05.py @@ -3,7 +3,7 @@ from taurus.external.qt import Qt from taurus.qt.qtgui.display import TaurusLabel from taurus.qt.qtgui.application import TaurusApplication -app = TaurusApplication(sys.argv) +app = TaurusApplication(sys.argv, cmd_line_parser=None) panel = Qt.QWidget() w = TaurusLabel(panel) w.setModel('sys/taurustest/1/state') diff --git a/doc/source/devel/examples/label06.py b/doc/source/devel/examples/label06.py index 0dfbe2a0..b3ca726e 100644 --- a/doc/source/devel/examples/label06.py +++ b/doc/source/devel/examples/label06.py @@ -3,7 +3,7 @@ from taurus.external.qt import Qt from taurus.qt.qtgui.display import TaurusLabel from taurus.qt.qtgui.application import TaurusApplication -app = TaurusApplication(sys.argv) +app = TaurusApplication(sys.argv, cmd_line_parser=None) panel = Qt.QWidget() layout = Qt.QGridLayout() panel.setLayout(layout) diff --git a/doc/source/devel/examples/parentmodel_issue_demo.py b/doc/source/devel/examples/parentmodel_issue_demo.py index 364daaac..bd8c54ca 100644 --- a/doc/source/devel/examples/parentmodel_issue_demo.py +++ b/doc/source/devel/examples/parentmodel_issue_demo.py @@ -15,7 +15,7 @@ from taurus.qt.qtgui.display import TaurusLabel import sys from taurus.qt.qtgui.application import TaurusApplication -app = TaurusApplication(sys.argv) +app = TaurusApplication(sys.argv, cmd_line_parser=None) # The problem arises in some situations when the Taurus parenting is not the same # as the Qt parenting. For demonstration we use 3 widgets: diff --git a/doc/source/devel/examples/taurusplot01.py b/doc/source/devel/examples/taurusplot01.py index 0ec508e1..3fa3b759 100644 --- a/doc/source/devel/examples/taurusplot01.py +++ b/doc/source/devel/examples/taurusplot01.py @@ -4,7 +4,7 @@ import sys from taurus.qt.qtgui.plot import TaurusPlot from taurus.qt.qtgui.application import TaurusApplication -app = TaurusApplication(sys.argv) +app = TaurusApplication(sys.argv, cmd_line_parser=None) ########################## # BEGUIN EXAMPLE CODE ########################## diff --git a/doc/source/devel/examples/taurusplot02.py b/doc/source/devel/examples/taurusplot02.py index c065bfc7..173bf2a6 100644 --- a/doc/source/devel/examples/taurusplot02.py +++ b/doc/source/devel/examples/taurusplot02.py @@ -4,7 +4,7 @@ import sys from taurus.qt.qtgui.plot import TaurusPlot from taurus.qt.qtgui.application import TaurusApplication -app = TaurusApplication(sys.argv) +app = TaurusApplication(sys.argv, cmd_line_parser=None) ########################## # BEGUIN EXAMPLE CODE ########################## diff --git a/doc/source/devel/examples/taurusplot03.py b/doc/source/devel/examples/taurusplot03.py index 55966be2..41559b61 100644 --- a/doc/source/devel/examples/taurusplot03.py +++ b/doc/source/devel/examples/taurusplot03.py @@ -4,7 +4,7 @@ import sys from taurus.external.qt import Qt from taurus.qt.qtgui.plot import TaurusPlot, CurveAppearanceProperties from taurus.qt.qtgui.application import TaurusApplication -app = TaurusApplication(sys.argv) +app = TaurusApplication(sys.argv, cmd_line_parser=None) ########################## # BEGIN EXAMPLE CODE ########################## diff --git a/doc/source/devel/examples/taurustrend01.py b/doc/source/devel/examples/taurustrend01.py index fcdd011d..db6b447b 100644 --- a/doc/source/devel/examples/taurustrend01.py +++ b/doc/source/devel/examples/taurustrend01.py @@ -4,7 +4,7 @@ import sys from taurus.qt.qtgui.plot import TaurusTrend from taurus.qt.qtgui.application import TaurusApplication -app = TaurusApplication(sys.argv) +app = TaurusApplication(sys.argv, cmd_line_parser=None) ########################## # BEGIN EXAMPLE CODE ########################## diff --git a/doc/source/devel/examples/taurusvalue01.py b/doc/source/devel/examples/taurusvalue01.py index c2cbc9a4..bc274378 100644 --- a/doc/source/devel/examples/taurusvalue01.py +++ b/doc/source/devel/examples/taurusvalue01.py @@ -3,7 +3,7 @@ from taurus.external.qt import Qt from taurus.qt.qtgui.application import TaurusApplication from taurus.qt.qtgui.panel import TaurusValue -app = TaurusApplication(sys.argv) +app = TaurusApplication(sys.argv, cmd_line_parser=None) panel = Qt.QWidget() layout = Qt.QGridLayout() panel.setLayout(layout) diff --git a/doc/source/devel/icon_example.py b/doc/source/devel/icon_example.py index e6ed4b1d..f594b442 100644 --- a/doc/source/devel/icon_example.py +++ b/doc/source/devel/icon_example.py @@ -23,7 +23,7 @@ class MyGUI(Qt.QMainWindow): if __name__ == "__main__": import sys - app = TaurusApplication() + app = TaurusApplication(cmd_line_parser=None) gui = MyGUI() gui.show() sys.exit(app.exec_()) diff --git a/doc/source/devel/icon_guide.rst b/doc/source/devel/icon_guide.rst index c7c0c6c6..446b34de 100644 --- a/doc/source/devel/icon_guide.rst +++ b/doc/source/devel/icon_guide.rst @@ -32,7 +32,7 @@ Taurus icon catalog ------------------- In order to explore the icon collections provided by Taurus, you can use the -`taurusiconcatalog` application, which will let you browse the icons. +`taurus icons` application, which will let you browse the icons. .. figure:: /_static/taurusiconcatalog-01.png :align: center diff --git a/doc/source/devel/taurus3to4.rst b/doc/source/devel/taurus3to4.rst index 46fdb5e6..21fbe704 100644 --- a/doc/source/devel/taurus3to4.rst +++ b/doc/source/devel/taurus3to4.rst @@ -4,22 +4,262 @@ Taurus 3.x to 4.x migration guide ================================== -This chapter explains how to migrate from an application written using Taurus 3.x -to Taurus 4.x. +Taurus 4 was released in July 2016 with the main goal of making Taurus scheme-agnostic +(i.e. not relying on Tango for its core functionalities). -.. todo:: - This section needs to be expanded. **Help wanted!**. - In the meanwhile, the following documents may be useful: +Being a major version change, +it is not fully backwards-compatible with the previous taurus 3.x versions. - - TEP3_ - - TEP14_ - - `Taurus 4 API changes`_ - - `Taurus 4 slides`_ +However, a design goal for the 4.x series was to smooth the transition from 3.x as much +as possible, and a backwards-compatibility layer which will mark old taurus code as +deprecated but otherwise attempt to transparently support it in Taurus4 whenever that +is possible. + +Thanks to this compatibility layer, a Taurus 3 application is likely to run on taurus 4 +after minimal or even no changes (but typically producing deprecation warnings and +possibly with some functionality slightly altered). + +A good strategy for migrating a taurus 3 application or widget to taurus 4 is to attempt +to run it as-is with taurus 4 and then try to remove any deprecation warnings one by one. +Most changes will be related to one of the following: + +- renamed methods and APIs (see the *API changes* section below), +- differences between Tango states and Taurus states (see the *Working with States* section below) +- Use of quantities for values (see the *Working with quantities* section below) + + +.. note:: + The main sources of information regarding the changes introduced in + Taurus 4 are the following two Enhancement proposals: + + - TEP3_ + - TEP14_ + + These changes are also treated in the `Taurus 4 slides`_ + + +API Changes +------------ + +The following is a table of Taurus 3.x public members (classes, methods, attributes, etc) that became deprecated in Taurus 4 + +This list is a best-effort to document changes, but it may not be 100% complete (please feel free to suggest changes) + +**IMPORTANT**: in some cases, the proposed alternative can be used as a drop-in replacement of the deprecated code, but in some others the code may need some adaptation. + ++-----------------------------------------------+---------------------------------------------------------------+ +| Member | Alternative(s) | ++===============================================+===============================================================+ +| TaurusConfigValue | TaurusAttribute / TaurusAttrValue | ++-----------------------------------------------+---------------------------------------------------------------+ +| TaurusConfigurationProxy | TaurusAttribute | ++-----------------------------------------------+---------------------------------------------------------------+ +| TaurusConfiguration | TaurusAttribute | ++-----------------------------------------------+---------------------------------------------------------------+ +| Configuration (helper) | Attribute (helper) | ++-----------------------------------------------+---------------------------------------------------------------+ +| Database (helper) | Authority (helper) | ++-----------------------------------------------+---------------------------------------------------------------+ +| TaurusManager.{g,s}etOperationMode | -- | ++-----------------------------------------------+---------------------------------------------------------------+ ++-----------------------------------------------+---------------------------------------------------------------+ +| xxxAttrValue.<foo> | | +| *(where <foo> is any config option)* | xxxAttribute.<foo> | ++-----------------------------------------------+---------------------------------------------------------------+ +| xxxAttribute.value | xxxAttribute.rvalue | ++-----------------------------------------------+---------------------------------------------------------------+ +| xxxAttribute.w_value | xxxAttribute.wvalue | ++-----------------------------------------------+---------------------------------------------------------------+ +| xxxAttribute.has_failed | xxxAttribute.error | ++-----------------------------------------------+---------------------------------------------------------------+ ++-----------------------------------------------+---------------------------------------------------------------+ +| TangoAttribute.{g,s}etDescription | TangoAttribute.description | ++-----------------------------------------------+---------------------------------------------------------------+ +| TangoAttribute.isInformDeviceOfErrors | -- | ++-----------------------------------------------+---------------------------------------------------------------+ +| TangoAttribute.displayValue | str | ++-----------------------------------------------+---------------------------------------------------------------+ +| TangoAttribute.getDisplayValue | TangoAttribute.getLabel | ++-----------------------------------------------+---------------------------------------------------------------+ +| TangoAttribute.getDisplayUnit | TangoAttribute.rvalue.units | ++-----------------------------------------------+---------------------------------------------------------------+ +| TangoAttribute.getStandardUnit | TangoAttribute.rvalue.units | ++-----------------------------------------------+---------------------------------------------------------------+ +| TangoAttribute.getUnit | TangoAttribute.rvalue.units | ++-----------------------------------------------+---------------------------------------------------------------+ +| TangoAttribute.unit | TangoAttribute.rvalue.units | ++-----------------------------------------------+---------------------------------------------------------------+ +| TangoAttribute.getDisplayWriteValue | -- | ++-----------------------------------------------+---------------------------------------------------------------+ +| TangoAttribute.getWritable | TangoAttribute.isWritable | ++-----------------------------------------------+---------------------------------------------------------------+ +| TangoAttribute.is{Scalar,Spectrum,Image} | TangoAttribute.data_format | ++-----------------------------------------------+---------------------------------------------------------------+ +| TangoAttribute.getMaxDim{X,Y} | TangoAttribute.getMaxDim | ++-----------------------------------------------+---------------------------------------------------------------+ +| TangoAttribute.getShape | *introspect the value shape if applicable* | ++-----------------------------------------------+---------------------------------------------------------------+ +| TangoAttribute.getParam | TangoAttribute.getAttributeInfoEx | ++-----------------------------------------------+---------------------------------------------------------------+ +| TangoAttribute.setParam | *use PyTango* | ++-----------------------------------------------+---------------------------------------------------------------+ +| TangoAttribute.getConfig | self *(merged)* | ++-----------------------------------------------+---------------------------------------------------------------+ +| TangoAttribute.getCRanges | TangoAttribute .range + .alarms + .warnings | ++-----------------------------------------------+---------------------------------------------------------------+ +| TangoAttribute.getCLimits | TangoAttribute.range | ++-----------------------------------------------+---------------------------------------------------------------+ +| TangoAttribute.getMinValue | TangoAttribute.range | ++-----------------------------------------------+---------------------------------------------------------------+ +| TangoAttribute.getMaxValue | TangoAttribute.range | ++-----------------------------------------------+---------------------------------------------------------------+ +| TangoAttribute.climits | TangoAttribute.range | ++-----------------------------------------------+---------------------------------------------------------------+ +| TangoAttribute.getCAlarms | TangoAttribute.alarms | ++-----------------------------------------------+---------------------------------------------------------------+ +| TangoAttribute.getMinAlarm | TangoAttribute.alarms | ++-----------------------------------------------+---------------------------------------------------------------+ +| TangoAttribute.getMaxAlarm | TangoAttribute.alarms | ++-----------------------------------------------+---------------------------------------------------------------+ +| TangoAttribute.min_alarm | TangoAttribute.alarms | ++-----------------------------------------------+---------------------------------------------------------------+ +| TangoAttribute.max_alarm | TangoAttribute.alarms | ++-----------------------------------------------+---------------------------------------------------------------+ +| TangoAttribute.calarms | TangoAttribute.alarms | ++-----------------------------------------------+---------------------------------------------------------------+ +| TangoAttribute.getCWarnings | TangoAttribute.warnings | ++-----------------------------------------------+---------------------------------------------------------------+ +| TangoAttribute.getMinWarning | TangoAttribute.warnings | ++-----------------------------------------------+---------------------------------------------------------------+ +| TangoAttribute.getMaxWarning | TangoAttribute.warnings | ++-----------------------------------------------+---------------------------------------------------------------+ +| TangoAttribute.min_warning | TangoAttribute.warnings | ++-----------------------------------------------+---------------------------------------------------------------+ +| TangoAttribute.max_warning | TangoAttribute.warnings | ++-----------------------------------------------+---------------------------------------------------------------+ +| TangoAttribute.cwarnings | TangoAttribute.warnings | ++-----------------------------------------------+---------------------------------------------------------------+ ++-----------------------------------------------+---------------------------------------------------------------+ +| TangoDevice.getState | TangoDevice.stateObj.read().rvalue *tango* or | +| | .state *agnostic* | ++-----------------------------------------------+---------------------------------------------------------------+ +| TangoDevice.getStateObj | TangoDevice.stateObj *tango* or | +| | .factory.getAttribute(state_full_name) *agnostic* | ++-----------------------------------------------+---------------------------------------------------------------+ +| TangoDevice.getSWState | TangoDevice.state | ++-----------------------------------------------+---------------------------------------------------------------+ +| TangoDevice.getValueObj | TangoDevice.state *agnostic or* stateObj.read *tango* | ++-----------------------------------------------+---------------------------------------------------------------+ +| TangoDevice.getDisplayValue | TangoDevice.state().name | ++-----------------------------------------------+---------------------------------------------------------------+ +| TangoDevice.getHWObj | TangoDevice.getDeviceProxy | ++-----------------------------------------------+---------------------------------------------------------------+ +| TangoDevice.isValidDev | (TangoDevice.getDeviceProxy() is not None) | ++-----------------------------------------------+---------------------------------------------------------------+ +| TangoDevice.getDescription | TangoDevice.description | ++-----------------------------------------------+---------------------------------------------------------------+ ++-----------------------------------------------+---------------------------------------------------------------+ +| TangoDatabase | TangoAuthority | ++-----------------------------------------------+---------------------------------------------------------------+ +| TangoAuthority.getHWObj | TangoAuthority.getDeviceProxy | ++-----------------------------------------------+---------------------------------------------------------------+ +| TangoAuthority.getValueObj | TangoAuthority.getTangoDB | ++-----------------------------------------------+---------------------------------------------------------------+ +| TangoAuthority.getDisplayValue | TangoAuthority.getFullName | ++-----------------------------------------------+---------------------------------------------------------------+ +| TangoAuthority.getDescription | TangoAuthority.description | ++-----------------------------------------------+---------------------------------------------------------------+ ++-----------------------------------------------+---------------------------------------------------------------+ +| TangoFactory.getAttributeInfo | TangoFactory.getAttribute | ++-----------------------------------------------+---------------------------------------------------------------+ +| TangoFactory.getConfiguration | TangoFactory.getAttribute | ++-----------------------------------------------+---------------------------------------------------------------+ +| TangoDevice.{g,s}etOperationMode | -- | ++-----------------------------------------------+---------------------------------------------------------------+ + + +Working with quantities +------------------------ + +One of the most visible changes in Taurus 4 is its use of quantities for the values +of numeric attributes. + +In Taurus 4 all the values of numeric (float or integer) attributes and their associated +properties (such as limits, warning levels, etc.) are :class:`pint.Quantity` objects provided +by the :mod:`pint` python module. A Quantity is essentially the combination of a `magnitude` +and a `unit`. In taurus 3.x all values were just "magnitudes", and their units were either +implicit or loosely described as a free string property, but not enforced in any way. + +By using Quantities Taurus 4 can automatically verify the dimensional validity of +operations and provide support for I/O using user-preferred units. + +Taurus 3 applications use `.value` or `.w_value` to get the read or write +magnitude of a taurus value, respectively. In taurus 4 these would be equivalent +to `.rvalue.magnitude` and `.wvalue.magnitude`, but the recommended way to adapt +a Taurus 3 application is to use the Quantity objects, not their magnitudes +(i.e., `rvalue` and `wvalue`) and refactor the code if necessary. + +For example, given the following taurus 3 code **where we assume that ampli is in meters**:: + + v = taurus.Attribute('sys/tg_test/1/ampli').read() + foo = 5 + v.value # here "5" is implicitly assumed to mean "5 meters" + +a lazy conversion to avoid deprecation warnings in taurus 4 would be:: + + v = taurus.Attribute('sys/tg_test/1/ampli').read() + foo = 5 + v.rvalue.magnitude + +...which is a very direct translation (and exactly what the automated backwards +compatibility layer already does for you). However, the recommended +conversion should use Quantities rather than magnitudes, e.g:: + + from taurus.core.units import UR # import the taurus unit registry + v = taurus.Attribute('sys/tg_test/1/ampli').read() + foo = 5 * UR.meters + v.value # use explicit units + +Or, using the Quantity constructor instead of the `Unit Registry`:: + + from taurus.core.units import Q_ # import the taurus Quantity factory + v = taurus.Attribute('sys/tg_test/1/ampli').read() + foo = Q_("5 meters") + v.value + +Finally, note that when using Quantities, you do not need to care about +matching the units, as long as they are dimensionally compatible:: + + foo = Q_("15 feet") + v.value + + +Working with Device states +-------------------------- + +Taurus 4 is all about being "scheme-agnostic". This means that the taurus core +(and ideally the main widgets as well) should not assume that the model objects +(attributes, devices, authorities) are of one specific source type (Tango, Epics, +Evaluation...) + +This implies that the APIs should be scheme-agnostic. In Taurus 3, the concept +of *device state* is completely "tango-centric" and it has been replaced in +Taurus 4 by a much more generic one where the devices are either "ready" or "not +ready" (this is of course much less informative, but it is generic enough to +accomodate schemes where the sources of data may not even be hardware-related). + +In Taurus 4, the Taurus device states are defined in the +`taurus.core.TaurusDevState` enumeration, and the tango device states are +supported by the tango scheme in `taurus.core.tango.DevState` enumeration, which +is a numerically-compatible translation of `PyTango.DevState` + +Some taurus 3.x applications may implement logic that depends on Tango states, +or maybe display information based on the rich palette of Tango state colors. +In these cases, when converting the application to Taurus 4 one needs to decide +if the simple Taurus states are enough (in which case one should refactor the +logic and use `device.state` to get the *Taurus* device state) or if the richer +tango states are required to the point of sacrificing the scheme-agnosticism of +the application (in which case one can use `device.stateObj.read().rvalue` to +obtain the *Tango* device state) .. _TEP3: http://sf.net/p/tauruslib/wiki/TEP3 .. _TEP14: http://sf.net/p/tauruslib/wiki/TEP14 -.. _`Taurus 4 API changes`: http://sf.net/p/tauruslib/wiki/Taurus4-API_changes -.. _`Taurus 4 slides`: https://indico.esrf.fr/indico/event/4/session/6/contribution/17/material/slides/
\ No newline at end of file +.. _`Taurus 4 slides`: https://indico.esrf.fr/indico/event/4/session/6/contribution/17/material/slides/ diff --git a/doc/source/devel/taurusgui_newgui.rst b/doc/source/devel/taurusgui_newgui.rst index b76fdf99..2e72f206 100644 --- a/doc/source/devel/taurusgui_newgui.rst +++ b/doc/source/devel/taurusgui_newgui.rst @@ -7,7 +7,7 @@ Creating GUIs with the TaurusGUI framework The easiest way to create a new GUI using Taurus is by invoking:: - taurusgui --new-gui + taurus newgui This shows a "wizard" application that will guide you through the process of creating a :class:`TaurusGui`-based GUI in a few minutes @@ -41,7 +41,7 @@ more advanced control can be exerted at several levels: - First, it is possible to edit the configuration files that define a TaurusGUI-based application. These are declarative python and XML files (editable as plain text) complemented by Qt settings files (editable with - the provided :ref:`taurusconfigbrowser <configurations>` application). + the provided :ref:`taurus config <configurations>` application). - On a lower level, custom specific widgets (created either programmatically, as in the :ref:`examples` or via the :ref:`Qt designer <taurusqtdesigner-tutorial>`) diff --git a/doc/source/index.rst b/doc/source/index.rst index 460ffce3..460ffce3 100755..100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst diff --git a/doc/source/numpy.inv b/doc/source/numpy.inv new file mode 100644 index 00000000..8cb1f0a0 --- /dev/null +++ b/doc/source/numpy.inv @@ -0,0 +1,5 @@ +# Sphinx inventory version 2 +# Project: NumPy +# Version: +# The remainder of this file is compressed using zlib. +xu0D&ĭ;ʅJ{R{@P Ǫ̜;õV]OM;Мf[ʃ:)Bz2p.&1.ЀT?wJ;OnCjJѠ%Km"j`RKIz.@H
?6} Ws`Z@ږEhy߮;q-ݏͽC Wi tu~>>
\ No newline at end of file diff --git a/doc/source/tep/TEP14.md b/doc/source/tep/TEP14.md index d5713ec5..80d0ba9d 100644 --- a/doc/source/tep/TEP14.md +++ b/doc/source/tep/TEP14.md @@ -158,7 +158,7 @@ Summary of API changes The deprecations introduced by this proposal can be identified in the code by the use of the `@tep14_deprecation` decorator and the calls to the `deprecated` function with the `rel='tep14'` argument. -The [Taurus4-API_changes](https://sourceforge.net/p/tauruslib/wiki/Taurus4-API_changes/) document is an attempt to explicitly list all the changes (it is not considered part of this TEP because it is likely to be modified to include more comments or missing changes) +The [Taurus4-API_changes](http://taurus-scada.org/devel/taurus3to4.html#api-changes) document is an attempt to explicitly list all the changes (it is not considered part of this TEP because it is likely to be modified to include more comments or missing changes) Links to more details and discussions @@ -215,18 +215,21 @@ Changes 2015-04-28 -[cpascual](http://sf.net/u/cpascual/) First draft based on parts moved from [TEP3][] and previous discussions with [tiagocoutinho](http://sf.net/u/tiagocoutinho/), [cfalcon](https://sf.net/u/cmft/) and [zreszela](http://sf.net/u/zreszela/) +[cpascual](https://github.com/cpascual/) First draft based on parts moved from [TEP3][] and previous discussions with [tiagocoutinho](http://sf.net/u/tiagocoutinho/), [cfalcon](https://sf.net/u/cmft/) and [zreszela](http://sf.net/u/zreszela/) 2015-11-23 -[cpascual](http://sf.net/u/cpascual/) Implementation proposal uploaded to taurus4-preview branch of official repo +[cpascual](https://github.com/cpascual/) Implementation proposal uploaded to taurus4-preview branch of official repo 2016-03-11 -[cpascual](http://sf.net/u/cpascual/) Completed missing sections, rewritted existing ones and passed to CANDIDATE +[cpascual](https://github.com/cpascual/) Completed missing sections, rewritted existing ones and passed to CANDIDATE 2016-03-16 -[cpascual](http://sf.net/u/cpascual/) Passing to ACCEPTED +[cpascual](https://github.com/cpascual/) Passing to ACCEPTED 2016-11-16 [mrosanes](https://github.com/sagiss/) Adapt TEP format and URL according TEP16 +2019-04-03 +[cpascual](https://github.com/cpascual/) Update outdated sf.net links + [TEP3]: http://www.taurus-scada.org/tep?TEP3.md diff --git a/doc/source/tep/index.rst b/doc/source/tep/index.rst index 9162ad27..9162ad27 100755..100644 --- a/doc/source/tep/index.rst +++ b/doc/source/tep/index.rst diff --git a/doc/source/tep/res/tep0_workflow.png b/doc/source/tep/res/tep0_workflow.png Binary files differindex e8cbf8c2..e8cbf8c2 100755..100644 --- a/doc/source/tep/res/tep0_workflow.png +++ b/doc/source/tep/res/tep0_workflow.png diff --git a/doc/source/tep/res/tep14_merge_Attr_and_Conf.png b/doc/source/tep/res/tep14_merge_Attr_and_Conf.png Binary files differindex 6248caff..6248caff 100755..100644 --- a/doc/source/tep/res/tep14_merge_Attr_and_Conf.png +++ b/doc/source/tep/res/tep14_merge_Attr_and_Conf.png diff --git a/doc/source/users/getting_started.rst b/doc/source/users/getting_started.rst index 5570282a..8378176a 100644 --- a/doc/source/users/getting_started.rst +++ b/doc/source/users/getting_started.rst @@ -26,22 +26,6 @@ Note: pip is already included in python>2.7.9 Note: some "extra" features of taurus have additional dependencies_. -Installing from sources manually (platform-independent) -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -You may alternatively install from a downloaded release package: - -#. Download the latest sources of taurus from http://pypi.python.org/pypi/taurus -#. Extract the downloaded source into a temporary directory and change to it -#. run:: - - pip install . - -#. test the installation:: - - python -c "import taurus; print taurus.Release.version" - -Note: some "extra" features of taurus have additional dependencies_. Linux (Debian-based) ~~~~~~~~~~~~~~~~~~~~ @@ -52,22 +36,22 @@ doing (as root):: aptitude install python-taurus -(see more detailed instructions in `this step-by-step howto -<https://sourceforge.net/p/sardana/wiki/Howto-SardanaFromScratch/>`__) +Note: `python3-taurus` and `python3-taurus-pyqtgraph` packages are already +built in https://salsa.debian.org , but are not yet part of the official debian +repositories -Windows -~~~~~~~ +Installing in a conda environment (Windows and linux) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -#. Install the `Python(x,y)`_ bundle (alternatively, you could install Python, - PyQt_, PLY_, and other dependencies_ independently, but `Python(x,y)`_ - will save you much worries about versions). -#. Download the latest Taurus windows binary from http://pypi.python.org/pypi/taurus -#. Run the installation executable -#. test the installation:: +First create a Conda_ environment with all the dependencies and activate it:: - C:\Python27\python -c "import taurus; print taurus.Release.version" + conda config --add channels conda-forge + conda config --add channels tango-controls # for windows, use "tcoutinho" instead of "tango-controls" + conda create -n py3qt5 python=3 pyqt=5 itango pytango lxml future guidata guiqwt ipython pillow pint ply pyqtgraph pythonqwt numpy scipy pymca + conda activate py3qt5 +Then install taurus and taurus_pyqtgraph using pip (as explained above) Working from Git source directly (in develop mode) -------------------------------------------------- @@ -75,15 +59,15 @@ Working from Git source directly (in develop mode) If you intend to do changes to Taurus itself, or want to try the latest developments, it is convenient to work directly from the git source in "develop" (aka "editable") mode, so that you do not need to re-install -on each change. - -You can clone taurus from our main git repository:: - - git clone https://github.com/taurus-org/taurus.git taurus +on each change:: -Then, to work in develop mode, just do:: + # install taurus in develop mode + git clone https://github.com/taurus-org/taurus.git + pip install -e ./taurus # <-- Note the -e !! - pip install -e ./taurus + # install taurus_pyqtgraph in develop mode + git clone https://github.com/taurus-org/taurus_pyqtgraph.git + pip install -e ./taurus_pyqtgraph # <-- Note the -e !! .. _dependencies: @@ -104,7 +88,7 @@ expected of Taurus (which are considered "extras"). For example: is done with PyQt4 and PyQt5, so many features may not be regularly tested with PySide and PySide2. -- The :mod:`taurus.qt.qtgui.plot` module requires PyQwt_, which is +- The :mod:`taurus.qt.qtgui.qwt5` module requires PyQwt_, which is only available when using PyQt4 and python2. As an alternative that supports both python2 and python3 and all the Qt bindings, refer to the taurus_pyqtgraph_ plugin. @@ -130,24 +114,11 @@ How you install the required dependencies depends on your preferred installation method: - For GNU/Linux, it is in general better to install the dependencies from - your distribution repositories if available. - -- For Windows users: many of these dependencies are already satisfied - by installing the `Python(x,y)`_ bundle. Also, most can be installed - from PyPI_ (e.g. using pip). For some versions, PyPI may not provide - pre-built windows binaries, so pip may try to compile from sources, - which takes long and may not succeed without some further work. In - those cases, one may use windows binaries from other versions and/or - wheel packages from the Silx_WheelHouse_. - -- In general, you can use pip to install dependencies for a given - extra feature (if they are in PyPI or in one of your configured - indexes). Use:: - - pip install taurus[NAME_OF_EXTRA] + your distribution repositories if available. A Conda_ environment can be + used alternatively (interesting for testing new features in isolation) -- The Conda_ package management system may also be used to install - most of the required dependencies. +- For Windows users, the recommended option is to use a Conda_ environment + (see above). - The `taurus-test Docker container`_ provides a Docker container (based on Debian) with all the dependencies pre-installed (including Tango and @@ -159,7 +130,6 @@ installation method: .. _pint: http://pint.readthedocs.org/ .. _future: https://python-future.org/ .. _PLY: http://www.dabeaz.com/ply/ -.. _Python(x,y): http://python-xy.github.io/ .. _Tango: http://www.tango-controls.org/ .. _PyTango: http://pytango.readthedocs.io .. _Qt: http://qt.nokia.com/products/ @@ -173,7 +143,6 @@ installation method: .. _pyepics: http://pypi.python.org/pypi/pyepics .. _spyder: http://pythonhosted.org/spyder .. _lxml: http://lxml.de -.. _Silx_WheelHouse: http://www.silx.org/pub/wheelhouse/ .. _PyPI: http://pypi.python.org/pypi .. _Conda: http://conda.io/docs/ .. _taurus-test Docker container: http://hub.docker.com/r/cpascual/taurus-test/ diff --git a/doc/source/users/introduction.rst b/doc/source/users/introduction.rst index a8526ff3..d22bcc06 100644 --- a/doc/source/users/introduction.rst +++ b/doc/source/users/introduction.rst @@ -47,7 +47,7 @@ four attributes (state, position, velocity, acceleration) of a Tango device from taurus.qt.qtgui.panel import TaurusForm from taurus.qt.qtgui.application import TaurusApplication - app = TaurusApplication(sys.argv) + app = TaurusApplication(sys.argv, cmd_line_parser=None) attrs = [ 'state', 'position', 'velocity', 'acceleration' ] model = [ 'motor/icepap/01/%s' % attr for attr in attrs ] @@ -66,7 +66,7 @@ four attributes (state, position, velocity, acceleration) of a Tango device The above example can even be achieved even without typing any code:: % cd taurus/qt/qtgui/panel - % taurusform motor/icepap/01/state motor/icepap/01/position motor/icepap/01/velocity + % taurus form motor/icepap/01/state motor/icepap/01/position motor/icepap/01/velocity For many more examples, See the :ref:`examples` page. diff --git a/doc/source/users/ui/configurations.rst b/doc/source/users/ui/configurations.rst index 8522aabf..f4e55539 100644 --- a/doc/source/users/ui/configurations.rst +++ b/doc/source/users/ui/configurations.rst @@ -18,14 +18,14 @@ Taurus Configuration Browser Application ---------------------------------------- You may browse the configuration of a TaurusMainWindow-based application -(e.g. any TaurusGUI) by launching the taurusconfigbrowser application +(e.g. any TaurusGUI) by launching the taurus config application with the following command:: - taurusconfigbrowser [<configuration.ini>] + taurus config [<configuration.ini>] Run the following command for more details:: - taurusconfigbrowser --help + taurus config --help In the figure below the taurusconfigbrowser application shows a taurus configuration .ini file containing three perspectives: 'LAST', diff --git a/doc/source/users/ui/devpanels.rst b/doc/source/users/ui/devpanels.rst index 0cf80e9f..77921cef 100644 --- a/doc/source/users/ui/devpanels.rst +++ b/doc/source/users/ui/devpanels.rst @@ -19,11 +19,11 @@ TaurusDevicePanel as a stand-alone application The :class:`TaurusDevicePanel` can be launched as a stand-alone application with the following command:: - taurusdevicepanel [options] [<device_name>] + taurus dev [options] [<device_name>] Run the following command for more details:: - taurusdevicepanel --help + taurus dev --help .. _tauruspanel: @@ -33,10 +33,10 @@ TaurusPanel as a stand-alone application The :class:`TaurusDevPanel` can be launched as a stand-alone application with the following command:: - tauruspanel [options] [<device_name>] + taurus panel [options] [<device_name>] Run the following command for more details:: - tauruspanel --help + taurus panel --help diff --git a/doc/source/users/ui/forms.rst b/doc/source/users/ui/forms.rst index 04702810..5b9b2a47 100644 --- a/doc/source/users/ui/forms.rst +++ b/doc/source/users/ui/forms.rst @@ -47,11 +47,11 @@ You may also use TaurusForm as a stand-alone application for controlling some attributes or devices from the control system. You can launch the stand-alone TaurusForm with the following command:: - taurusform [options] [<model_list>] + taurus form [options] [<model_list>] Run the following command for more details:: - taurusform --help + taurus form --help The model list is optional and is a space-separated list of models for TaurusForm. Valid models are: attribute names, device names or alias. See @@ -66,7 +66,7 @@ representing its attributes and/or widgets. .. figure:: /_static/forms03.png :align: center - A taurusform created with the following command `taurusform sys/tg_test/1 + A Taurus form created with the following command `taurus form sys/tg_test/1 sys/tg_test/1/state sys/tg_test/1/status sys/tg_test/1/string_scalar sys/tg_test/1/boolean_scalar sys/tg_test/1/boolean_spectrum sys/tg_test/1/float_scalar sys/tg_test/1/float_spectrum diff --git a/doc/source/users/ui/plot.rst b/doc/source/users/ui/plot.rst index 53aafe6d..5ce2a8d3 100644 --- a/doc/source/users/ui/plot.rst +++ b/doc/source/users/ui/plot.rst @@ -33,11 +33,11 @@ You may also use :class:`TaurusPlot` as a stand-alone application for displaying attributes from the control system or for plotting a function. You can launch the stand-alone :class:`TaurusPlot` with the following command:: - taurusplot [options] [<model_list>] + taurus qwt5 plot [options] [<model_list>] Run the following command for more details:: - taurusplot --help + taurus qwt5 plot --help The <model_list> is a space-separated list of models for :class:`TaurusPlot`. Valid models are: SPECTRUM attribute names or alias, and `Xattrname|Yattrname` constructions for indicating X-Y scatter plots. @@ -283,24 +283,7 @@ Here are some tips for entering valid date/time values: the units are case-sensitive (e.g., "-1D" is not valid) - also, the keyword "now" (case-insensitive) can be used as a synonym of "+0s". - -.. _tauruscurve: -TaurusCurveDialog -================= - -Taurus also offers an alternative widget for plotting one-dimensional data: -:class:`TaurusCurveDialog`. This widget is based on the guiqwt_ library and -is currently less developed and tested than :class`TaurusPlot`. - -The :class:`TaurusCurveDialog` widget can be launched as a stand-alone -application with the following command:: - - tauruscurve [options] [<model_list>] - -Run the following command for more details:: - - tauruscurve --help .. references .. _numpy: http://numpy.scipy.org/ diff --git a/doc/source/users/ui/taurusdemo.rst b/doc/source/users/ui/taurusdemo.rst index 3f5aac9a..49bd73c2 100644 --- a/doc/source/users/ui/taurusdemo.rst +++ b/doc/source/users/ui/taurusdemo.rst @@ -15,15 +15,15 @@ demonstration purposes. Taurus Demo Application ----------------------- -taurusdemo is an application that gives an overview of some of the +Taurus demo is an application that gives an overview of some of the widgets available in Taurus. taurusdemo can be launched with the following command:: - taurusdemo + taurus demo Run the following command for more details:: - taurusdemo --help + taurus demo --help .. figure:: /_static/taurusdemo.png :align: center diff --git a/doc/source/users/ui/taurusgui.rst b/doc/source/users/ui/taurusgui.rst index e75cea59..b7f7804c 100644 --- a/doc/source/users/ui/taurusgui.rst +++ b/doc/source/users/ui/taurusgui.rst @@ -36,44 +36,13 @@ opposed to launching TaurusGUI directly), so you should refer to the specific instructions for launching that GUI. Still, you may want to launch TaurusGui directly for debugging an specific -application or for creating a new GUI from scratch. For this, use the following -command:: - - taurusgui [options] - -Options:: - - -h, --help show this help message and exit - --config-dir=CONFIG_DIR - use the given configuration directory for - initialization - --new-gui launch a wizard for creating a new TaurusGUI - application - --version show program's version number and exit - - Taurus Options: - Basic options present in any taurus application - - --taurus-log-level=LEVEL - taurus log level. Allowed values are (case - insensitive): critical, error, warning/warn, info, - debug, trace - --taurus-polling-period=MILLISEC - taurus global polling period in milliseconds - --taurus-serialization-mode=SERIAL - taurus serialization mode. Allowed values are (case - insensitive): serial, concurrent (default) - --tango-host=TANGO_HOST - Tango host name - - - -.. note:: - for backwards compatibility: - taurusgui CONFIG_DIR - - is equivalent to: - taurusgui --config-dir=CONFIG_DIR +application. For this, use the following command:: + + taurus gui [options] + +For creating a new taurusgui from scratch, use:: + + taurus newgui General structure of a TaurusGUI application @@ -305,7 +274,7 @@ Also, some other temporary panels may be dynamically created depending on the ex - `1D Scans`, :ref:`a trend <trend_ui>` that plots the values of scalar attributes during some scan macro executions. -.. note:: You can run `taurusgui macrogui` for seeing an example of a TaurusGUI- +.. note:: You can run `taurus gui macrogui` for seeing an example of a TaurusGUI- based application that provides the aforementioned panels .. figure:: /_static/macrogui01.png @@ -313,7 +282,7 @@ Also, some other temporary panels may be dynamically created depending on the ex :width: 80% Macro-related panels (taken from the macrogui example that can be launched - with `taurusgui macrogui`) + with `taurus gui macrogui`) In most specific GUIs the macroserver and door name to use are pre-configured and the user does not need to change them. Sometimes though, you may want to alter it. @@ -344,10 +313,10 @@ Taurus includes examples of TaurusGUI-based applications for demonstration purpo - launch command - Comment * - example01 - - taurusgui example01 + - taurus gui example01 - Included in Taurus (<taurus>/qt/qtgui/taurusgui/conf/tgconf_example01) * - Macrogui - - taurusgui macrogui + - taurus gui macrogui - Included in Taurus (<taurus>/qt/qtgui/taurusgui/conf/tgconf_macrogui) * - Alba's beam lines control GUIs - ctblxx (xx is the beamline number) diff --git a/doc/source/users/ui/taurusimage.rst b/doc/source/users/ui/taurusimage.rst index 3bf5715b..ea859146 100644 --- a/doc/source/users/ui/taurusimage.rst +++ b/doc/source/users/ui/taurusimage.rst @@ -40,28 +40,8 @@ You may also use TaurusImageDialog as a stand-alone application for showing imag attributes from the control system. You can launch the stand-alone Taurus Image with the following command:: - taurusimage [options] <model> - -Options:: + taurus guiqwt image [options] <model> - -h, --help show this help message and exit - --demo show a demo of the widget - --version show program's version number and exit +Run the following command for more details:: - Taurus Options: - Basic options present in any taurus application - - --taurus-log-level=LEVEL - taurus log level. Allowed values are (case - insensitive): critical, error, warning/warn, info, - debug, trace - --taurus-polling-period=MILLISEC - taurus global polling period in milliseconds - --taurus-serialization-mode=SERIAL - taurus serialization mode. Allowed values are (case - insensitive): serial, concurrent (default) - --tango-host=TANGO_HOST - Tango host name - - -The model is the name of a taurus image attribute
\ No newline at end of file + taurus guiqwt image --help
\ No newline at end of file diff --git a/doc/source/users/ui/trend.rst b/doc/source/users/ui/trend.rst index 581c4658..0fe2efc8 100644 --- a/doc/source/users/ui/trend.rst +++ b/doc/source/users/ui/trend.rst @@ -37,11 +37,11 @@ You may also use TaurusTrend as a stand-alone application for showing trends of attributes from the control system. You can launch the stand-alone TaurusTrend with the following command:: - taurustrend [options] [<model_list>] + taurus qwt5 trend [options] [<model_list>] Run the following command for more details:: - taurustrend --help + taurus qwt5 trend --help The model list is optional and is a space-separated list of models for TaurusTrend. @@ -208,11 +208,11 @@ guiqwt_. The :class:`TaurusTrend2DDialog` widget can be launched as a stand-alone application with the following command:: - taurustrend2d <array_attribute_name> + taurus guiqwt trend2d <array_attribute_name> Run the following command for more details:: - taurustrend2d --help + taurus guiqwt trend2d --help .. _guiqwt: https://pypi.python.org/pypi/guiqwt |
