wcprod

This is a python API to use data production tools for generating a large-scale photon dataset in CIDeR-ML collaboration.

Training of "Optical SIREN" model for a Water Cherenkov detector requires serious statistics of photon simulation. A typical dataset requires 100E6 photon simulated at 10-100E6 positions/directions. This requires running simulations over many processes (>>10k) and considerable effort in book-keeping of managing processes and output files. wcprod aims to address this challenge of process management in a large-scale sample production.

For users, you might find a complimentary documentation at the ReadTheDocs.

For developers, make sure you read the Contribution Guide.

Installation

Once git clone this repository, go inside and:

pip install .

Interacting with the database

The primary access point is the wcprod_db python class. All functions of this class are available through wcprod command-line interface (CLI).

Check (list) all available functions

wcprod -h

Get help on a specific function

wcprod test_db get_random_config -h

Generating a new project

You can generate a new project using wcprod CLI.

However, it might be useful to learn how a project can be generated from a configuration file, what information is stored, and how to retrieve.

Tutorial materials are gathered in a publicly accessible folder in this google drive link.

Creating a production database

Coming soon