Installation
============

Installation via pip
--------------------

The package is available via PyPi via:

.. code-block:: console

  pip install qmatchatea

After cloning the repository, a local installation via pip is
also possible via:

.. code-block:: console

  pip install .

The dependencies necessary for a correct installation are listed in the `requirements.txt` file
in the repository.


Optional packages are not needed for a correct functioning of the package.
However, some of the functionalities will be precluded. In particular:

- mpi4py, enables data parallelism
- cupy, enables GPU simulations

To start working with the package go to :doc:`quickstart`.