.. highlight:: shell

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


Stable release
--------------

To install residuals_weather_storage, run this command in your terminal:

.. code-block:: console

    $ pip install rws_py

This is the preferred method to install residuals_weather_storage, 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/


From source
-----------

The source for residuals_weather_storage can be downloaded from the `Gitlab repo`_.

You can either clone the public repository:

.. code-block:: console

    $ git clone git@git.uni-due.de:spp-2403/residuals_weather_storage.git



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

.. code-block:: console

    $ pip install .

.. _Gitlab repo: https://git.uni-due.de/spp-2403/residuals_weather_storage