Skip to content

grand-mother/grand

Repository files navigation

GRANDlib

workflow codecov docs appimage

Core Python 3 package for the offline data handling and analysis for the GRAND Collaboration.

The GRAND library - GRANDlib - can be used under docker to define a correct environment, read GRAND_wiki for more information, else you must install ROOT library and compile TURTLE and GULL library under your computer.

Don't forget to initialize grand library before use it with script env/setup.sh only in the root of the package

$ git clone https://github.com/grand-mother/grand.git
$ cd grand
$ source env/setup.sh

Check the online documentation for further details, but best study the examples.

Examples and scripts can be found under examples/ and scripts/ subdirectories

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. See env/readme.md, a docker environnement is provided.

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

If you use GRANDlib in your work, we ask you that you please cite the following paper: R. Alves Batista et al., GRANDlib: A simulation pipeline for the Giant Radio Array for Neutrino Detection (GRAND) (arXiv:2408.10926).

If you are citing GRANDlib in a document that will be uploaded to the arXiv, please consider using the LaTeX or BibTeX entries provided by INSPIRE (link here):

@article{GRAND:2024atu,
 author = "Alves Batista, Rafael and others",
 collaboration = "GRAND",
 title = "{GRANDlib: A simulation pipeline for the Giant Radio Array for Neutrino Detection (GRAND)}",
 eprint = "2408.10926",
 archivePrefix = "arXiv",
 primaryClass = "astro-ph.IM",
 month = "8",
 year = "2024"
}