Installing NuRadioReco¶

Installation using Pip¶

The latest NuRadioReco release can be installed using pip:
pip install NuRadioReco
This will also install the required dependencies.

Important

If you want the current version or you want to contribute to NuRadioReco, you need to install if manually.

Manual Installation¶

If you don’t already have it installed, install Git.

Then clone the NuRadioReco repository
git clone https://github.com/nu-radio/NuRadioReco.git
and add it to you PYTHONPATH.

Dependencies¶

To install all (optional and non-optional) dependencies available in pip at once, use the command
pip install numpy scipy matplotlib astropy tinydb tinydb-serialization aenum h5py mysql-python pymongo dash plotly sphinx peakutils

Core Dependencies¶

NuRadioReco requires the following packages to work properly:

radiotools: Can also be installed using git and needs to be added to the PYTHONPATH

All other dependencies can be installed using pip
numpy:
pip install numpy
scipy:
pip install scipy
matplotlib:
pip install matplotlib
astropy:
pip install astropy
tinydb: tinydb version 4.1.1 or newer is required.
pip install tinydb tinydb-serialization
Advanced enum:
pip install aenum

Optional Dependencies¶

These packages are recommended to be able to use all of NuRadioReco’s features:

h5py to open HDF5 files:
pip install h5py
To access detector databases:
For SQL datbases install MySQL and mysql-python:
pip install mysql-python
For MongoDB databases install:
pip install pymongo
To use the Event Display you need plotly and dash:
pip install dash
pip install plotly
If you want templates to show up in the Event Display, you need to set up an environment variable NURADIORECOTEMPLATES and have it point to the template directory.
The documentation is created using Sphinx
pip install sphinx
Some debug plots need peakutils:
pip install peakutils
To read ARIANNA files, Snowshovel need to be installed.