Skip to main content

Electron and Photon Instructions generator for XENON

Project description

epix

Electron and Photon Instructions generator for XENON

The job of epix is to load XENONnT Geant4 MC data and produce inputs for wfsim, using nestpy for the quanta generation and DBSCAN for the clustering of the individual steps.

Installation

Assuming you are working on top of our montecarlo_environment (/project2/lgrandi/xenonnt/singularity-images/xenonnt-montecarlo-development.simg):

git clone https://github.com/XENONnT/epix
cd epix
python3 setup.py develop --user

Usage

Only an input file is needed to run epix:

bin/run_epix --InputFile <path_and_filename>

The other keyword arguments are:

Argument Description Default
--Detector Detector to be used. Has to be defined in epix.detectors XENONnT
--DetectorConfigOverride Config file to overwrite default epix.detectors settings; see examples in the configs folder in epix.detectors
--CutOnEventid If selected, the next two arguments act on the G4 event id, and not the entry number (default) false
--EntryStart First event to be read 0
--EntryStop How many entries from the ROOT file you want to process all
--MicroSeparation DBSCAN clustering distance (mm) 0.05
--MicroSeparationTime Clustering time (ns) 10
--TagClusterBy decide if you tag the cluster (particle type, energy depositing process) according to first interaction in it (time) or most energetic (energy) time
--MaxDelay Time after which we cut the rest of the event (ns) 1e7
--SourceRate Event rate for event separation
- 0 for no time shift (G4 time remains)
- -1 for clean time shift between events
- >0 (Hz) for random spacing
0
--JobNumber Job number in full chain simulation. Offset is computed as JobNumber * n_simulated_events/SourceRate, where n_simulated_events is read from file. 0
--OutputPath Output file path Same directory as input file
--Debug Tell epix if you want timing outputs false

0.1.0 (2021-03-30)

  • E-Field format change (#23)
  • strax interface (#19)

0.0.6 (2021-02-12)

  • Set e- recoil type as default (#15)

0.0.5 (2021-02-08)

  • Change detector naming (#13)

0.0.4 (2021-02-08)

  • New Efield format loading (#11)
  • Store NEST id as recoil type (#10)

0.0.3 (2021-01-26)

  • Clustering and event separation (#6)

0.0.2 (2021-01-25)

  • Added detector volumes (#8)

0.0.1 (2020-01-21)

  • Initial working release as python package

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

epix-0.1.0.tar.gz (19.4 kB view details)

Uploaded Source

File details

Details for the file epix-0.1.0.tar.gz.

File metadata

  • Download URL: epix-0.1.0.tar.gz
  • Upload date:
  • Size: 19.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/3.7.3 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.8.8

File hashes

Hashes for epix-0.1.0.tar.gz
Algorithm Hash digest
SHA256 b016aed711c8df1d76b1f35e481a5915c34dec727e2d03f77aa3dad1d6aa4d3f
MD5 0034b82036c229990c50b0eefcf8a0f4
BLAKE2b-256 86d8571c3bb306e4d20dc3e0cd699bd4d3d2e68f8c03e9813898a5a4d661db3a

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page