.. tcs_lib documentation master file, created by sphinx-quickstart on Thu Apr 27 17:52:00 2017. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. Welcome to tcs_lib's documentation! =================================== ``tcs_lib`` provides some functionalities to simply or proxy the interaction with the `HET `_ Telescope Control System (TCS) This documentation is also available on `het-tcs-lib.readthedocs.io `_. .. image:: https://readthedocs.org/projects/het-tcs-lib/badge/?version=latest :target: https://het-tcs-lib.readthedocs.io/en/latest/?badge=latest :alt: Documentation Status Installation ------------ .. toctree:: :maxdepth: 2 install :py:mod:`tcs_event` - ZeroMQ based listener ------------------------------------------- This module is the core of ``tcs_lib``. It is a ZeroMQ based listener that wait for the next TCS event, composed of a header and a payload (a dictionary) and returns it. .. toctree:: :maxdepth: 2 tcs_event Mock TCS events --------------- In order to test :mod:`~tcs_lib.tcs_event` and code using it, some TCS event is needed. Having your own telescope might not be ideal. Therefore we provide a ZeroMQ server, :class:`tcs_lib.zmq_server.ZMQServer`, that can stream TCS like events, and two event generators, :class:`tcs_lib.zmq_server.TCSMockEvent` and :class:`tcs_lib.zmq_server.TCSDBReplay`, that can be plugged into the server. They are also conveniently packaged and exposed via the ``tcs_replay`` executable described in :doc:`tcs_replay`. .. toctree:: :maxdepth: 2 tcs_replay zmq_server TCS proxy --------- .. toctree:: :maxdepth: 2 tcs_proxy Other modules ------------- .. toctree:: :maxdepth: 2 tcs_errors string_helpers Contribution guide ------------------ .. toctree:: :maxdepth: 2 contributions About ----- .. toctree:: :maxdepth: 1 license authors release_notes changelog todos Indices and tables ================== * :ref:`genindex` * :ref:`modindex` * :ref:`search`