. highlight:: console

============================
Development and contributing
============================

Setting up the development environment
======================================

1.
Clone the repository with ::

   git clone git@github.com:NikUstimenko/acoustotreams.git

or ::

   git clone https://github.com/NikUstimenko/acoustotreams.git

and enter the directory ::

   cd acoustotreams

2.
This step is optional, but you might want to create an environment where acoustotreams and the
development tools are created ::

   conda env create --name acoustotreams-dev python

Activate the environment with::

   conda activate acoustotreams-dev

3.
Setup the package with ::

   pip install -e .

This last step makes the program available in the environment independently of the
current folder. This is especially necessary for correctly building the documentation.