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.

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

Feature/ehinkle eventdisplay #81

Merged
17 changes: 17 additions & 0 deletions event_display/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Flow File Event Displays

## Single Module Event Displays

### Overview

There are currently two Python-based event displays available for visualizing single module data and simulation files run through flow. The event displays are version-specific, with one intended for use on files run through `module0_flow` and one for use on files run through `proto_nd_flow`. The source code for each event display is available in the corresponding subdirectory, e.g. `event_display/proto_nd_flow`, and is adapted from [this older event display script](https://github.com/larpix/larpix-v2-testing-scripts/blob/master/event-display/module0_evd.py). The event displays here are set up to run inside Jupyter notebooks, and examples of such usage are also given in the corresponding subdirectories. The examples involve using files stored on NERSC, so if the notebooks are run outside of NERSC, you will need to download both the flow file you would like to visualize and a module geometry file.

### File Locations

In general, single module data files can be found [in this file system.](https://portal.nersc.gov/project/dune/data/) For the examples provided in the associated notebooks, the following files are used:

- [Module 1 geometry file](https://portal.nersc.gov/project/dune/data/Module1/TPC12/module1_layout-2.3.16.yaml)
- [Module 1 data file run through `module0_flow` (charge only)](https://portal.nersc.gov/project/dune/data/Module1/reco/charge_only/events_2022_02_09_17_23_09_CET.gz.h5)
- [Module 1 data file run through `proto_nd_flow` (charge only)](https://portal.nersc.gov/project/dune/data/Module1/TPC12/reflow-test/packet_2022_02_09_17_23_09_CET.module1_flow.h5)

Additional Module 1 charge-only data files run through `module0_flow` can be found [here](https://portal.nersc.gov/project/dune/data/Module1/reco/charge_only/), and additional Module 1 charge-only data files run through `proto_nd_flow` can be found [here](https://portal.nersc.gov/project/dune/data/Module1/TPC12/reflow-test/).
Loading