Installation

python

To install package in your python distribution,

1. check that you are using your desired python version:

   which python
   

2. install package with setup tools:

   python setup.py install
   

conda

To create a virtual environment and install the package with conda,

1. check that you are using the desired conda version:

   which conda
   

2. execute:

   conda env create -f environment.yml
   

3. install package with setup tools:

   python setup.py install
   

development

Instead of installing the package, set it up in develop mode so that changes in the source files are seen without having to reinstall the package:

python setup.py develop

docs

Use the Makefile in the docs directory to create documentations in the format of choice. For example:

make html