Contributing

Thanks for helping to build lenapy!

Report issues or bugs

If you encounter a bug, unexpected behavior, or see something that could be improved:

Open an issue on the GitHub Issues page,
Describe the problem clearly, with a minimal reproducible example if possible,
Indicate the version of Lenapy, Python, and platform you’re using.

Bug reports, feature suggestions, and usability feedback are all welcome.

Seek support or ask questions

If you have questions about how to use Lenapy:

First, check the documentation,
If your question isn’t answered there, post your question in the Issues with the label question.

We aim to respond as quickly as possible and encourage community help.

Retrieve the code: forking and cloning the Repository

Make a fork of the lenapy repo and clone the fork.

A documentation is available on GitHub to help platform users create a fork: https://docs.github.com/fork-a-repo

git clone https://github.com/<your-github-username>/lenapy.git
cd lenapy

You may want to add https://github.com/CNES/lenapy as an upstream remote repository.

git remote add upstream https://github.com/CNES/lenapy

Creating a Python environment

We have conda environment YAML file with all the necessary dependencies.

conda env create -f environment.yml --name=lenapy-dev

to create a conda environment and install all the dependencies.

Building lenapy

Lenapy is a pure-python repository. Development installation should be as simple as cloning the repository and running the following in the cloned directory:

conda activate lenapy-dev
python -m pip install --no-deps -e .

If you have any trouble, please open an issue on the lenapy issue tracker.

Style

Lenapy uses black and isort for formatting. If you installed lenapy with python -m pip install -e ".[dev]" these tools will already be installed.

Running tests

Lenapy uses pytest for testing. You can run tests from the main lenapy directory as follows:

pytest tests

Alternatively you may choose to run only a subset of the full test suite. For example to test only the writers submodule we would run tests as follows:

pytest tests/writers

Coverage

It is possible to check code coverage

pytest --cov=lenapy --cov-report=html

You can still use all the usual pytest command-line options in addition to those.

Pre-Commit Hooks

Install and build the pre commit tool as:

python -m pip install -e ".[dev]"
pre-commit install

to install a few plugins like black, isort, and pylint. These tools will automatically be run on each commit. You can skip the checks with git commit --no-verify.

Documentation

We use numpydoc for our docstrings.

Building the docs is possible with

$ conda env create -f environment.yml --name=lenapy-dev
$ conda activate lenapy-dev
$ python -m pip install -e ".[dev]"
$ cd doc
$ sphinx-build -b html doc doc/build