Welcome to photonlib’s documentation!

This software is used to facilitate a large-scale simulation sample production for optical SIREN model. Training of this model requires to sample positions and directions of a photon everywhere and every direction in the detector. The number of samples (job configuration) can easily reach hundreds of millions. Book-keeping of the data production is implemented using sqlite database and automated job submission scripts in this software which repository can be found here. to interface a photon library file used for Liquid Argon Time Projection Chamber (LArTPC) detectors. For the installation, tutorial notebooks, and learning what photon library is, please see the software repository.

Getting started

You can find a quick guide to get started below.

Install photonlib

git clone https://github.com/cider-ml/wcprod
cd wcprod
pip install . --user

You can install to your system path by omitting --user flag. If you used --user flag to install in your personal space, assuming $HOME, you may have to export $PATH environment variable to find executables.

export PATH=$HOME/.local/bin:$PATH

Download data file

Package Reference

• wcprod
  • Submodules