Getting Started#

Getting the source code#

To get a copy of the code, you need to clone the git repository (either via SSH or HTTPS) from GitHub. Once you have done this, go inside the top-level folder of the repository.

cd ess

Creating a development environment#

To install all non-optional dependencies for a complete development environment, we recommend creating a conda environment from the environment.yml file.

conda env create -f environment.yml
conda activate ess-developer

Once you have activated the environment, you want to pip install it locally using

python -m pip install -e .

Running the unit tests#

To run the unit tests, simply

cd tests/
python -m pytest

Building Documentation#

To build the documentation:

cd docs
sphinx-build -b html . build

This will build the documentation inside the docs/build folder. If rebuilding the documentation is slow it can be quicker to remove the docs build directory and start a fresh build.