Installation

Installing with pip

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)"

Some optional Taurus features have additional dependencies.

Linux (Debian-based)

Taurus is available in the official Debian repositories. Install the Python 3 package with:

apt install python3-taurus

For plotting support, Debian also provides:

apt install python3-taurus-pyqtgraph

The exact Taurus version depends on the Debian release. If you need a newer version, consider using a conda environment or pip instead.

Installing in a conda environment

In a conda environment (we recommend creating one specifically for Taurus):

conda install -c conda-forge taurus taurus_pyqtgraph

Optionally, you may also want to install Tango:

conda install -c conda-forge pytango

Warning

There is a known issue with PyQt5 versions >= 5.15.4 where Taurus Designer is not showing Taurus widgets. See Designer known issues for possible workarounds.

With Pixi

Pixi can be used to create a development environment directly from the Taurus repository.

After installing Pixi, clone the Taurus repository and run:

` $ pixi install `

The default environment includes Taurus with Tango and PyQt5 support.

Additional environments are available for other model schemes, Qt bindings, and compatibility configurations. For example:

` $ pixi run -e epics test $ pixi run -e tango-pyqt6 test $ pixi run -e tango-pyside6 test $ pixi run -e tango95 test `

The selected environment can also be used to run Taurus commands directly. For example, to open a Taurus form using the Tango model scheme and the PySide6 binding:

` $ pixi run -e tango-pyside6 taurus form sys/tg_test/1/double_scalar `

The documentation and code checks can be run with:

` $ pixi run doc $ pixi run precommit `

See the pixi.toml file in the repository root for the complete list of available environments and their definitions.

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:

# optional: if using a conda environment, pre-install dependencies:
# e.g, for basic dependencies:
conda install -c conda-forge python=3 click numpy pint pyqt ply lxml plotpy pyqtgraph
# ... and some extra dependencies (pick the ones you need)
conda install -c conda-forge pytango pyepics spyder pymca
# ... and if you want to run the test suite:
conda install -c conda-forge pytest pytest-qt pytest-xvfb pytest-forked pytest-xdist flaky
# ... and for auto-checking code style for contributing:
conda install -c conda-forge pre-commit
# ... and for building the docs:
conda install -c conda-forge sphinx sphinx_rtd_theme graphviz

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

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

Dependencies

Strictly speaking, Taurus only depends on numpy, click, and pint, 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 a supported Qt Python binding. Taurus is primarily developed and tested with PyQt.
The image widgets require the plotpy 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:

On GNU/Linux, dependencies can be installed from the distribution repositories when available, or in an isolated Conda environment.
On Windows, using a Conda environment is recommended.

Optional dependencies can be installed using pip extras:

Extra	Description
`qt`	Common dependencies for Taurus Qt functionality
`pyqt5`	Qt dependencies with the PyQt5 binding
`pyqt6`	Qt dependencies with the PyQt6 binding
`pyside6`	Qt dependencies with the PySide6 binding
`tango`	Tango model support
`epics`	EPICS model support
`h5file`	HDF5 file support
`qt-editor`	TaurusEditor widget support (spyder) [deprecated]

For example:

pip install "taurus[pyqt6,tango]"

The former taurus-* extra names are kept temporarily for backward compatibility.