diff options
Diffstat (limited to 'doc/source/users')
| -rw-r--r-- | doc/source/users/getting_started.rst | 77 | ||||
| -rw-r--r-- | doc/source/users/introduction.rst | 4 | ||||
| -rw-r--r-- | doc/source/users/ui/configurations.rst | 6 | ||||
| -rw-r--r-- | doc/source/users/ui/devpanels.rst | 8 | ||||
| -rw-r--r-- | doc/source/users/ui/forms.rst | 6 | ||||
| -rw-r--r-- | doc/source/users/ui/plot.rst | 21 | ||||
| -rw-r--r-- | doc/source/users/ui/taurusdemo.rst | 6 | ||||
| -rw-r--r-- | doc/source/users/ui/taurusgui.rst | 53 | ||||
| -rw-r--r-- | doc/source/users/ui/taurusimage.rst | 26 | ||||
| -rw-r--r-- | doc/source/users/ui/trend.rst | 8 |
10 files changed, 58 insertions, 157 deletions
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 |