.. include:: ./substitutions.rst

.. _install:

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

dvas is available on |pypi|, which should make its installation straightforward.
In a terminal, type:

.. code-block:: python

    pip install dvas

And that will take care of things. dvas uses `semantic versioning <https://semver.org/>`_.
The latest stable version is |version|.

The most recent release of dvas is also available for download/cloning from its
`Github repository <https://github.com/MeteoSwiss-MDA/dvas/releases/latest/>`_, in which case the
install command becomes:

.. code-block:: python

    cd ./where/you/stored/dvas/
    pip install -e .

Requirements
------------
dvas is compatible with the following python versions:

.. literalinclude:: ../../setup.py
    :language: python
    :lines: 43

Furthermore, dvas relies on a few external modules, which will be automatically installed by ``pip``
if required:

.. literalinclude:: ../../setup.py
    :language: python
    :lines: 44-59

Testing the installation
------------------------

To ensure that dvas was installed properly, try to call the help of its high-level entry point. In a
terminal, type:

.. code-block:: none

   dvas_init_arena -h

This should return the following information:

.. literalinclude:: dvas_help_msg.txt
    :language: none