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

It is recommended to use *diggrtoolbox* in a virtualenvironment such as `virtualenv <https://virtualenv.pypa.io/en/stable/>`_. Please refer to the documentation of virtualenv and/or `virtualenvwrapper <https://virtualenvwrapper.readthedocs.io/en/latest/>`_ or `pipenv <https://docs.pipenv.org/>`_ to see how to set it up.

The latest version of *diggrtoolbox* can be obtained from `github <https://github.com/diggr/diggrtoolbox>`_.

Install the latest version
---------------------------

You can install the latest version via pip::

    pip install git+https://github.com/diggr/diggrtoolbox

Development
-----------

If you plan to develop *diggrtoolbox* it is recommended to clone the github repository::

    git clone git@github.com/diggr/diggrtoolbox

Installation is performed using pip, but in editable mode, i.e. such that changes in the source take effect immediately::

    pip install -e ./diggrtoolbox