How to get started
New to NuRadioMC? This page provides some links to interactive .ipynb notebooks that should help you get started to run your first neutrino simulation,
and familiarize yourself with the .nur data format used by NuRadioMC.
It also has some links to further documentation and examples.
Should you still have questions / issues after running through these, feel free to contact the developers via github or slack.
Installation
To install NuRadioMC and NuRadioReco, you can use pip:
pip install nuradiomc
This installs the latest release version of NuRadioMC. If you want to use the development version, or intend to contribute, see the installation instructions here.
Simulating a neutrino detector with NuRadioMC
Interactive notebook example showing how to simulate a neutrino detector
This example can be found at NuRadioMC/examples/Interactive/W01-simulate-neutrino-detector.ipynb.
It is based on the examples at NuRadioMC/examples/01_Veff_simulation and NuRadioMC/examples/07_RNO_G_simulation.
Additional information about running a simulation can be found here.
Reading a .nur file
Interactive notebook example showing how to read a .nur file
This example can be found at NuRadioReco/examples/Interactive/W02-reading-nur-files.ipynb.
It shows how to navigate the quantities stored in NuRadio’s custom data structure, the nur file.
An extensive description of the NuRadio data structure can be found here.
Running a simple analysis with NuRadioReco
(WIP)