grand package

Core Python 3 package for the offline software of the GRAND Collaboration.

Quick start

The grand package can be installed from PyPI using pip, e.g. as:

pip install grand

Note that Python 3.8 or above is required. On Linux you can get it as an AppImage including grand dependencies as:

wget https://github.com/grand-mother/grand/releases/download/appimage/python3-x86_64.AppImage
chmod u+x python3-x86_64.AppImage

Check the online documentation for further details.

How to contribute

Issues can be reported on GitHub.

You can also contribute back to the code with Pull Requests PR. Note that you first need to fork and clone this repository. On Linux a development environment is provided. It can be enabled by sourcing the setup.sh script.

In order to be accepted your changes are expected to successfully pass the integration tests. You can run does locally as:

python -m tests

License

The GRAND software is distributed under the LGPL-3.0 license. See the provided LICENSE and COPYING.LESSER files.