Contributing

Discussions

If you have any questions or suggestions about inept, please do so here: https://github.com/BRGM/inept/discussions.

Repository

The public repository is https://github.com/brgm/inept.

You can clone and start working on the code with:

$ git clone https://github.com/BRGM/inept.git
$ cd inept/

For now, the developments are done on a restricted repository: https://gitlab.inria.fr/charms/inept. The github repository is a mirror of the main branch.

Preparing the environment

You can prepare a (conda) virtual environment with:

$ conda create -n inept pip
$ conda activate inept

Install the development dependencies with:

$ pip install -r requirements.txt

Run the tests (pytest) with:

$ pytest

Building the documentation

The documentation sources are in the docs/ directory:

$ cd docs/

Install sphinx and its dependencies with:

$ cd docs/
$ pip install -r requirements

and the nbsphinx dependencies with:

$ conda install -c conda-forge pandoc

Build the documentation with:

$ make html

Open the file docs/_build/index.html in your browser to see the result.