.. qeg-nmr-qua documentation master file

Welcome to qeg-nmr-qua's documentation!
========================================

**qeg-nmr-qua** is a Python library for controlling the OPX-1000 low-frequency front-end module 
for solid state nuclear magnetic resonance experiments, particularly for fluorine (19F) spins.

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

   installation
   quickstart
   examples
   api/index

Features
--------

* **OPX-1000 Configuration**: Structured configuration management for the OPX-1000 low-frequency front-end module
* **Experiment Management**: Experiment design and exectution with high-level QUA programming
* **Data Analysis**: Built-in data saving and analysis tools (in development)
* **Spectroscopy**: Specialized script for NMR Probe spectroscopy experiments. WARNING: Possible Hardware Damage if used improperly.

Indices and tables
==================

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