PyTango
|Doc Status|
|Gitlab Build Status|
|Pypi Version|
|Python Versions|
|Conda|
Main website: http://pytango.readthedocs.io
Python binding for Tango_, a library dedicated to distributed control systems.
Description
PyTango_ exposes the complete Tango C++ API
_ through the tango
python module.
It also adds a bit of abstraction by taking advantage of the Python capabilities:
tango.client
provides a client access to device servers and databases.tango.server
provides base classes to declare and run device servers.
Requirements
PyTango_ is compatible with python 3.9+.
General dependencies:
- cppTango_ >= 9.5.0, and its dependencies: omniORB4 and libzmq
Boost.Python
_ >= 1.71
Python dependencies:
- numpy_ >= 1.13.3 < 2.0
- psutil_
- packaging_
Build dependencies:
- pypa-build_
- scikit-build-core_
Optional dependencies (test):
- gevent_
- pytest_
- pytest-forked_
- pytest-cov_
- pytest-asyncio_
.. note:: As a general rule, cppTango_ and pytango_ should share the same major
and minor version (for a version X.Y.Z
, X
and Y
should
match).
On some systems you may need to install omniORB4
and libzmq
related
development packages.
Install
PyTango_ is available on PyPI_ as pytango
, with pre-built binaries for some platforms
(you need pip>=19.3, so upgrade first if necessary)::
$ python -m pip install --upgrade pip
$ python -m pip install pytango
Alternatively, pre-built PyTango_ binaries can be installed from Conda Forge_
::
$ conda install -c conda-forge pytango
For the very latest code, or for development purposes, PyTango_ can be built and installed from the
sources
. This is complicated by the dependencies - see the Getting Started section in the documentation.
Usage
To test the installation, import tango
and check tango.utils.info()
::
>>> import tango
>>> print(tango.utils.info())
PyTango 9.5.0.dev0 (9, 5, 0, 'dev', 0)
PyTango compiled with:
Python : 3.11.4
Numpy : 1.23.2
Tango : 9.5.0
Boost : 1.82.0
PyTango runtime is:
Python : 3.11.4
Numpy : 1.26.0
Tango : 9.5.0
PyTango running on:
uname_result(system='Darwin', node='osloxf01', release='22.6.0', version='Darwin Kernel Version 22.6.0: Wed Jul 5 22:22:05 PDT 2023; root:xnu-8796.141.3~6/RELEASE_ARM64_T6000', machine='arm64')
For an interactive use, consider using ITango_, a tango IPython_ profile.
Documentation
Check out the documentation_ for more information.
Support and contribution
You can get support from the Tango forums
, for both Tango and PyTango_ questions.
All contributions, PR and bug reports
_ are welcome, please see: How to Contribute
_ !
.. |Doc Status| image:: https://readthedocs.org/projects/pytango/badge/?version=latest
:target: http://pytango.readthedocs.io/en/latest
:alt:
.. |Gitlab Build Status| image:: https://img.shields.io/gitlab/pipeline-status/tango-controls/pytango?branch=develop&label=develop
:target: https://gitlab.com/tango-controls/pytango/-/pipelines?page=1&scope=branches&ref=develop
:alt:
.. |Pypi Version| image:: https://img.shields.io/pypi/v/PyTango.svg
:target: https://pypi.python.org/pypi/PyTango
:alt:
.. |Python Versions| image:: https://img.shields.io/pypi/pyversions/PyTango.svg
:target: https://pypi.python.org/pypi/PyTango/
:alt:
.. |Conda| image:: https://img.shields.io/conda/v/conda-forge/pytango
:target: https://anaconda.org/conda-forge/pytango
:alt:
.. _Tango: http://tango-controls.org
.. _Tango C++ API: https://tango-controls.github.io/cppTango-docs/index.html
.. _PyTango: http://gitlab.com/tango-controls/pytango
.. _PyPI: http://pypi.python.org/pypi/pytango
.. _Conda Forge: https://anaconda.org/conda-forge/pytango
.. _scikit-build-core: https://github.com/scikit-build/scikit-build-core
.. _pypa-build: https://github.com/pypa/build
.. _cppTango: https://gitlab.com/tango-controls/cppTango
.. _libtango: http://tango-controls.org/downloads
.. _Boost.Python: https://www.boost.org/doc/libs/release/libs/python/doc/html/index.html
.. _numpy: http://pypi.python.org/pypi/numpy
.. _packaging: http://pypi.python.org/pypi/packaging
.. _psutil: http://pypi.python.org/pypi/psutil
.. _setuptools: http://pypi.python.org/pypi/setuptools
.. _gevent: http://pypi.python.org/pypi/gevent
.. _pytest: https://docs.pytest.org/en/latest/
.. _pytest-forked: https://github.com/pytest-dev/pytest-forked
.. _pytest-cov: https://github.com/pytest-dev/pytest-cov
.. _pytest-asyncio: https://github.com/pytest-dev/pytest-asyncio
.. _ITango: http://pypi.python.org/pypi/itango
.. _IPython: http://ipython.org
.. _documentation: http://pytango.readthedocs.io/en/latest
.. _Tango forums: http://tango-controls.org/community/forum
.. PR and bug reports: PyTango
.. sources: PyTango
.. _How to Contribute: http://pytango.readthedocs.io/en/latest/how-to-contribute.html#how-to-contribute