Getting started¶
Installing¶
Installing with pip (platform-independent)¶
Using pip is the simplest approach. The following command will automatically download and install the latest release of Taurus:
pip install taurus --egg
You can test the installation by running:
python -c "import taurus; print taurus.Release.version"
Note 1: the –egg parameter is necessary (see this ticket). You can also add other parameters (e.g. –user)
Note 2: pip is already included in python>2.7.9 (or python 3.4.0 for the 3.x series)
Installing from PyPI manually (platform-independent)¶
You may alternatively install from a downloaded release package:
Download the latest release of taurus from http://pypi.python.org/pypi/taurus
Extract the downloaded source into a temporary directory
type:
python setup.py install
test the installation:
python -c "import taurus; print taurus.Release.version"
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
(see more detailed instructions in this step-by-step howto)
Windows¶
Download the latest windows binary from http://pypi.python.org/pypi/taurus
Run the installation excecutable
test the installation:
C:\Python26\python -c "import taurus; print taurus.Release.version"
Windows installation shortcut¶
This chapter provides a quick shortcut to all windows packages which are necessary to run taurus on your windows machine
- from Python(x,y)
- Download and install a python 2.6/2.7 compatible version of python(x,y) from here
- Finally:
- Download and install latest PLY from PLY downdoad page (necessary for jdraw synoptics only)
- Download and install latest PyTango from PyTango downdoad page
- Download and install latest taurus from Taurus downdoad page
Working from Git source without installing¶
Sometimes it is convenient to work directly from the git source without installing.
You can clone taurus from our main git repository:
git clone git://git.code.sf.net/p/tauruslib/taurus.git taurus
Then, if you decide to work directly from Git code (without installing):
add <taurus_root_dir>/lib to PYTHONPATH
add <taurus_root_dir>/scripts to PATH
build the resources:
cd <taurus_root_dir> python setup.py build_resources
Dependencies¶
Taurus has dependencies on some python libraries. After you installed taurus you can check the state of the dependencies by doing:
>>> import taurus
>>> taurus.check_dependencies()
Checking required dependencies of taurus.core...
Checking for Python >=2.6.0... [OK] (Found 2.6.2)
Checking for PyTango >=7.1.0... [OK] (Found 7.1.0)
Checking required dependencies of taurus.qt...
Checking for PyQt >=4.4.3... [OK] (Found 4.5.0)
Checking for PyQwt >=5.2.0... [OK] (Found 5.2.1)
Checking OPTIONAL dependencies of taurus.qt...
Checking for Qub >=1.0.0... [OK] (Found 1.0.0)
Checking for qtcontrols >=1.0.0... [OK] (Found 1.0.0)
You may already have PyTango installed. You will need PyTango 7 or later. You can check by doing:
python -c 'import PyTango; print PyTango.Release.version'
If that fails or it reports and older version follow the PyTango installation steps to properly install PyTango.
You may already have PyQt installed. You will need PyQt 4.4 or later. You can check by doing:
python -c 'import PyQt4.Qt; print PyQt4.Qt.QT_VERSION_STR'
Optional packages¶
The plotting widgets are only available if you have PyQwt. You may already have PyQwt installed. You will need PyQwt 5.2.0 or later. You can check it by doing:
python -c 'import PyQt4.Qwt5; print PyQt4.Qwt5.QWT_VERSION_STR'
The image widgets are provided by the guiqwt library. The widgets based on this library replace the previously used Qub-based image widget which is now considered deprecated in Taurus
The Gauge widgets are only available if you have the python extension of qtcontrols. qtcontrols is part of QTango.
The JDraw synoptics widgets are only available if you have the
ply
package installed.The NeXus browser widget is only available if you have PyMca installed