.. _tutorials:

Tutorials
=========

The pairinteraction software comes with a graphical user interface (GUI) and a Python API. The GUI provides a quick way
to calculate Rydberg interaction potentials, lifetimes, and energy shifts in the presence of external fields. The Python
API is designed to automatize calculations and to have more fine-grained control.

.. _tutorial-api:

Tutorials - Python API
----------------------

**Introduction**

The following jupyter notebooks introduce the Python API. The other tutorials build on this introduction.

.. nbgallery::

    examples_python/quick_start
    examples_python/concepts

**Examples Demonstrating Basic Usage**

We show exemplary applications of the Python API, ranging from the calculation of single-atom properties such as
lifetimes to calculations of pair potentials.

.. nbgallery::

    examples_python/stark_map
    examples_python/pair_potentials
    examples_python/lifetimes
    examples_python/perturbative_c3_c6

**Examples From Publications**

We show how pairinteraction's Python API can be applied to solve complex problems and reproduce results from literature.

.. nbgallery::

    examples_python/perturbative_h_eff
    examples_python/pair_potential_efield_sensitivity
    examples_python/atom_ion_interaction
    examples_python/mqdt

.. _tutorial-gui:

Tutorials - Graphical User Interface
------------------------------------

The graphical user interface (GUI) of pairinteraction can be started by executing

.. code-block:: bash

    pairinteraction gui

from the command line. Tutorials for the graphical user interface will be added in the future.

.. image:: examples_gui/preview.png
    :alt: GUI Preview