.. qmatchatea documentation master file, created by
   sphinx-quickstart on Thu Nov  4 12:41:36 2021.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to qmatchatea's documentation!
======================================

**Quantum Matcha Tea** (Quantum MAny Target quantum Circuit Hpc App) is a Python library 
that simulates quantum circuits with Tensor Networks (currently MPS and TTN).

Check out the :doc:`chapters/installation` section for information about the installation
procedure and :doc:`chapters/quickstart` to immediately start working with the package.
Afterwards, you can see the details of the function to run the simulation in :doc:`chapters/interface`.
To see the details of the output of the simulation visit the :doc:`chapters/observables` page.
If you are interested in data parallelization refer to :doc:`chapters/par_simulations`.
If you want to understand the subtelties of the simulation or you want a finer control over
the evolution of the state see :doc:`chapters/py_emulator`.

Finally, when you download an upgrade remember to always check the :doc:`chapters/changelog`!

.. toctree::
   :maxdepth: 1
   :caption: Contents:

   chapters/installation
   chapters/quickstart
   chapters/interface
   chapters/par_simulations
   chapters/observables
   chapters/py_emulator
   chapters/circuit
   chapters/operations
   chapters/utils
   chapters/changelog

License
=======
The project `qmatchatea` in this `gitlab repository <https://baltig.infn.it/quantum_matcha_tea_internal/py_api_quantum_matcha_tea>`_
is licensed under the following license:

`Apache License 2.0 <https://opensource.org/licenses/Apache-2.0>`_

The license applies to the files of this project as indicated
in the header of each file, but not its dependencies.

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

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