###########################
ICOtronic API Documentation
###########################

*******
Purpose
*******

The ICOtronic package contains a  command line tool  called |icon|_ and a `Python library`_ to control the `ICOtronic system`_ and acquire data.

.. |icon| replace:: ``icon``
.. _icon: https://mytoolit.github.io/ICOtronic/#icon-cli-tool
.. _Python library: https://pypi.org/project/icotronic/


This documentation **describes the Python library API** (i.e. how to create programs that use the `ICOtronic system`_). If you want information about the  command line tool |icon|_ and the `ICOtronic system`_ itself we recommend that you check out the `general ICOtronic documentation`_.

.. _ICOtronic system: https://www.mytoolit.com/icotronic/

.. _general ICOtronic documentation: https://mytoolit.github.io/ICOtronic/

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   usage
   api
   examples