.. highlight:: shell

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


From sources
------------

The sources for Ordr2 can be downloaded from the `Github repo`_.

You can clone the public repository:

.. code-block:: console

    $ git clone https://git.cpi.imtek.uni-freiburg.de/holgi/ordr2

You should create a new virtual environment prior to installing and activate it

.. code-block:: console

    $ python3 -m venv venv-ordr2
    $ source venv-ordr2/bin/activate

Once you have a copy of the source, you can install it with:

.. code-block:: console

    $ pip install .

.. _Github repo: https://git.cpi.imtek.uni-freiburg.de/holgi/ordr2


Stable release (CURRENTLY NOT AVAILABLE)
----------------------------------------

To install Ordr2, run this command in your terminal:

.. code-block:: console

    $ pip install ordr2

This is the preferred method to install Ordr2, as it will always install the
most recent stable release.

If you don't have `pip`_ installed, this `Python installation guide`_ can guide
you through the process.

.. _pip: https://pip.pypa.io
.. _Python installation guide: http://docs.python-guide.org/en/latest/starting/installation/