Installing from source
======================

.. role:: bash(code)
   :language: bash

Hermes is written entirely in Python. Future versions of Hermes are planned to be released
as a Python package, but as of now you will need to install everything manually.

As a first step clone hermes from its `repository <https://mgit.cs.uni-saarland.de/timopgros/hermes>`_.

.. code-block:: bash

   git clone https://mgit.cs.uni-saarland.de/timopgros/hermes HERMESPATH

Assuming :bash:`HERMESPATH` is absolute and points to the hermes repository, can now add it to your
:bash:`PYTHONPATH`, e.g. by inserting the following line to you :bash:`.bashrc` or :bash:`.zshrc`:

.. code-block:: bash

   export PYTHONPATH=${PYTHONPATH}:$HERMESPATH

This change will not go into effect before restarting your terminal, or running
.. code-block::

   source ~/.bashrc # (or zshrc)

If you are using Windows please refer to `this page on the python docs <https://docs.python.org/3/using/windows.html#configuring-python>`_
in order to find out, how to permanently modify your PYTHONPATH.

Requirements
-------------
Next, you'll also have to install all hermes dependencies manually. These are

- Git 1.7.0 or newer
- Python 3.6 or newer
- `matplotlib <https://matplotlib.org/stable/users/installing.html>`_
- `PyTorch <https://pytorch.org/get-started/locally>`_
- `gitpython <https://gitpython.readthedocs.io/en/stable/intro.html>`_

There are also some optional dependencies, as of now, these are

- pandas
- `python-telegram-bot <https://python-telegram-bot.org/>`_

Installing the PyPi package
===========================
Not yet available :(