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

.. note::
	It is recommended to install *GREOPy* inside of a virtual environment.

You can use pip to install this package in two ways:

* *GREOPy* is published on `pypi.org <https://pypi.org/project/GREOPy/>`_, so simply run

.. code-block:: bash

	$ python -m pip install GREOPy

* or directly install the package from its repository by running

.. code-block:: bash

	$ python -m pip install git+https://codeberg.org/JPHackstein/GREOPy

Optional dependencies e.g. for documentation and development tools can be specified during the installation by running e.g.

.. code-block:: bash

	$ python -m pip install GREOPy[docs,dev]

All optional dependencies are listed in the `pyproject.toml <https://codeberg.org/JPHackstein/GREOPy/src/branch/main/pyproject.toml>`_ file.