Quick start for contributing

Source code

You can check out the latest sources with the command:

git clone https://github.com/mind-inria/hidimstat.git

Test suite

For testing, we recommend you install the test dependencies with pip:

pip install hidimstat[test]

This will install pytest and the following extensions: pytest-cov, pytest-randomly, pytest-xdist, pytest-html, pytest-timeout, pytest-durations

After this installation, you can launch the test suite:

pytest test

Style guide

The code is formatted black and isort.

To apply the required dependencies and style your code:

pip install -e '.[style]'
isort .
codespell --toml pyproject.toml
black .

Examples

To run the examples, we recommend you install the example dependencies with pip:

pip install hidimstat[example]

For running the examples, it’s necessary to install Matplotlib >= 3.9.0 and seaborn >= 0.9.0.

After this installation, you can run any example in the examples folder.

Or you can download some of them from the documentation.

Documentation

The documentation is built with Sphinx. We recommend you install the documentation dependencies with pip:

pip install hidimstat[doc]

After this installation, you can build the documentation from the source using the Makefile in doc_conf:

make html

For more information, look at the developer documentation