ScintiPix is a Geant4-based simulation for scintillator and neutron-GPS workflows with optical-photon recording at an optical-interface plane.

This repository also includes a Python configuration layer for YAML-driven run setup, optical transport helpers, and lightweight analysis examples.

Quick Start

The recommended setup path is pixi.

pixi install
pixi run build-sim

Run a macro-driven simulation:

pixi run run-neutron-gps

Run a YAML-driven example:

pixi run python examples/SimulationSetup/CanonEF50mmf1p0L_example.py
pixi run scintipix data/CanonEF50mmf1p0L_run/macros/CanonEF50mmf1p0L_run.mac

Core Workflows

• Run Geant4 directly from a macro: pixi run run-neutron-gps
• Generate and run from YAML: pixi run python examples/runSimulation/run_simulation_from_yaml.py examples/yamlFiles/CanonEF50mmf1p0L_example.yaml
• Transport optical-interface hits to the intensifier plane: pixi run python examples/photonTransportation/optical_transport_example.py examples/yamlFiles/CanonEF50mmf1p0L_example.yaml
• Run the full simulation -> transport -> intensifier -> Timepix pipeline: pixi run python examples/endToEnd/end_to_end_example.py examples/yamlFiles/CanonEF50mmf1p0L_example.yaml
• Generate lightweight analysis outputs: pixi run python examples/analysisLite/hdf5_lite_analyzer_example.py data/CanonEF50mmf1p0L_run/simulatedPhotons/photon_optical_interface_hits.h5

For the full YAML -> simulation -> transport -> intensifier -> Timepix pipeline, see examples/endToEnd/README.md.

For analysis examples and module-level guidance, see analysis/README.md.

Repository Layout

• sim/: Geant4 application code, headers, and macro files
• src/config/: YAML models, validation, and macro-generation utilities
• src/optics/: optical transport and lens tooling
• catalogs/: bundled lens and scintillator catalogs
• examples/: runnable workflow examples
• analysis/: lightweight analysis helpers for generated HDF5 outputs
• test/: unit tests and test documentation

Further Documentation

• Examples index: examples/README.md
• Analysis helpers: analysis/README.md
• HDF5 schema reference: docs/hdf5_schema.md
• Intensifier module: docs/intensifier.md
• End-to-end workflow: examples/endToEnd/README.md
• Tests: test/README.md
• Catalog overview: catalogs/README.md
• Lens catalog notes: catalogs/lenses/README.md
• Scintillator catalog notes: catalogs/scintillators/README.md

License

ScintiPix is distributed as open-source software under a GPLv3 License, with LANL open source approval (reference O5110). Please see LICENSE for more details.