Getting started

Installing

Installing with pip (platform-independent)

Taurus can be installed using pip. The following command will automatically download and install the latest release of Taurus (see pip –help for options):

pip install taurus

You can test the installation by running:

python -c "import taurus; print taurus.Release.version"

Note: pip is already included in python>2.7.9

Note: some “extra” features of taurus have additional dependencies.

Linux (Debian-based)

Since v3.0, Taurus is part of the official repositories of Debian (and Ubuntu and other Debian-based distros). You can install it and all its dependencies by doing (as root):

aptitude install python-taurus

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

Installing in a conda environment (Windows and linux)

First create a Conda environment with all the dependencies and activate it:

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 click
conda activate py3qt5

Then install taurus and taurus_pyqtgraph using pip (as explained above)

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:

# install taurus in develop mode
git clone https://github.com/taurus-org/taurus.git
pip install -e ./taurus  # <-- Note the -e !!

# 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

Strictly speaking, Taurus only depends on numpy, pint and future but that will leave out most of the features normally expected of Taurus (which are considered “extras”). For example:

  • Interacting with a Tango controls system requires PyTango.

  • Interacting with an Epics controls system requires pyepics.

  • Using the taurus Qt widgets, requires either PyQt (v4 or v5) or PySide (v1 or v2). Note that most development and testing of is done with PyQt4 and PyQt5, so many features may not be regularly tested with PySide and PySide2.

  • The 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.

  • The image widgets require the guiqwt library.

  • The JDraw synoptics widgets require the PLY package.

  • The NeXus browser widget requires PyMca5.

  • The TaurusEditor widget requires spyder.

  • The TaurusGui module requires lxml.

For a complete list of “extra” features and their corresponding requirements, execute the following command:

taurus check-deps

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. A Conda environment can be used alternatively (interesting for testing new features in isolation)

  • 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 Epics running environments) on which you can install taurus straight away.