GRANDlib

|workflow| |codecov| |docs| |appimage|

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

.. contents:: Contents :local: :depth: 2

Environment

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

.. code:: bash

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

Documentation

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

Examples

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

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

License

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

.. Local links

.. _COPYING.LESSER: https://github.com/grand-mother/grand/blob/master/COPYING.LESSER

.. _LICENSE: https://github.com/grand-mother/grand/blob/master/LICENSE

.. _setup.sh: https://github.com/grand-mother/grand/blob/master/env/setup.sh

.. Externals links

.. _AppImage: https://github.com/grand-mother/python/releases/download/continuous/python3-x86_64.AppImage

.. _GRAND_wiki: https://github.com/grand-mother/grand/wiki

.. _ROOT: https://root.cern/install/

.. _TURTLE: https://github.com/niess/turtle

.. _GULL: https://github.com/niess/gull

.. _GRAND: http://grand.cnrs.fr

.. _online documentation: https://grand-mother.github.io/grand-docs

.. _PR: https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests

.. _PyPI: https://pypi.org/project/grand

.. _Python 3: https://www.python.org

.. _reported on GitHub: https://github.com/grand-mother/grand/issues

.. Badges

.. |appimage| image:: https://img.shields.io/badge/python3-x86_64-blue.svg :target: AppImage_

.. |codecov| image:: https://codecov.io/gh/grand-mother/grand/branch/master/graph/badge.svg :target: https://codecov.io/gh/grand-mother/grand

.. |docs| image:: https://img.shields.io/badge/docs-ready-brightgreen.svg :target: online documentation_

.. |workflow| image:: https://github.com/grand-mother/grand/workflows/Tests/badge.svg :target: https://github.com/grand-mother/grand/actions?query=workflow%3ATests

Citing

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):

.. code:: latex

@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" }