Skip to content
Snippets Groups Projects
Commit 5aca3b39 authored by Stefan Reck's avatar Stefan Reck
Browse files

docs

parent 3a362c59
No related branches found
No related tags found
No related merge requests found
......@@ -17,26 +17,24 @@ OrcaSong: Preprocessing KM3NeT data for DL
:alt: Codacy Badge
:target: https://www.codacy.com/app/sreck/OrcaSong?utm_source=github.com&utm_medium=referral&utm_content=StefReck/OrcaSong&utm_campaign=Badge_Grade
The documentation for OrcaSong can be found at https://ml.pages.km3net.de/OrcaSong!
OrcaSong is a part of the Deep Learning efforts of the neutrino telescope KM3NeT.
Find more information about KM3NeT on http://www.km3net.org.
In this regard, OrcaSong is a project that preprocesses raw KM3NeT detector data
OrcaSong is a project for preprocessing raw KM3NeT ORCA or ARCA event data
for the use with deep neural networks, making use of km3nets data processing
pipline km3pipe. Two different modes are available:
- For convolutional networks: produce n-dimensional 'images' (histograms)
- For graph networks: produce a list of nodes, each node representing infos about a hit in the detector
Currently, only simulations with a hdf5 data format are supported as an input.
The input to Orcasong are offline/aanet root files, and the output are "DL" files
in the hdf5 format, which can e.g. be used by the OrcaNet software.
For more info, read the documentation here https://ml.pages.km3net.de/OrcaSong!
OrcaSong is a part of the Deep Learning efforts of the neutrino telescope KM3NeT.
Find more information about KM3NeT on http://www.km3net.org.
OrcaSong can be installed via pip by running::
pip install orcasong
You can get a list of all the bash commands in orcasong by typing::
orcasong --help
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment