Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update READMEs in PISA examples folder #471

Merged
merged 3 commits into from
Apr 2, 2023
Merged

Update READMEs in PISA examples folder #471

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
582bb49
Update READMEs in PISA examples folder
asogaard Mar 31, 2023
2c420e6
Update examples/05_pisa/README.md
asogaard Mar 31, 2023
33ff08c
Update examples/05_pisa/README.md
asogaard Mar 31, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions examples/05_pisa/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
# PISA examples

Be aware that the examples in this folder presuppose that GraphNeT is installed with [PISA](https://github.com/icecube/pisa).
In addition, it should be noted that the use of PISA is a highly specialised case, albeit an important one for neutrino oscillation physics in IceCube, and that any oscillation analysis example would require an amount of statistics that is not feasible to bundle with a software package like GraphNeT.
For these reasons, examples in this folder are intentionally not self-contained, in contrast to the other provided examples.
However, the GraphNeT developers are happy to work with users who are interested in leveraging the PISA functionality that is included in this package.
2 changes: 1 addition & 1 deletion examples/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Examples are grouped into five numbered subfolders, roughly in order of how you
2. **Data.** Reading in data in intermediate formats, plotting feature distributions, and converting data between intermediate file formats. These examples are entirely self-contained and can be run by anyone.
3. **Weights.** Fitting per-event weights.
4. **Training.** Training GNN models on various physics tasks.
5. **PISA.** Fitting and plotting oscillation analysis contours. These examples presuppose that GraphNeT has been installed with [PISA](https://github.com/icecube/pisa).
5. **PISA.** Fitting and plotting oscillation analysis contours. These examples presuppose that GraphNeT has been installed with [PISA](https://github.com/icecube/pisa), and the examples are intentionally not self-contained due to their specialised nature.

Each subfolder contains similarly numbered example scripts.
Each example script comes with a simple command-line interface and help functionality, e.g.
Expand Down