``endaq``: the Python library for enDAQ sensors
===============================================
The ``endaq`` package is a comprehensive, user-centric Python API for working with enDAQ™ data and devices.

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

   api_ref
   example_notebooks


Installation
------------

The ``endaq`` package is `available on PyPI <https://pypi.org/project/endaq/>`_, and can be installed via `pip`:

.. code::

    pip install endaq

For the most recent features that are still under development, you can also use `pip` to install endaq directly from `the GitHub repository <https://github.com/MideTechnology/endaq-python/>`_:

.. code::

    pip install git+https://github.com/MideTechnology/endaq-python.git@development


Indices and tables
------------------

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

License
-------

The `endaq-python` repository is licensed under the MIT license. The full text can be found in the `LICENSE file <https://github.com/MideTechnology/endaq-python/blob/main/LICENSE>`_.