[kavyawadhwa134]

Brings PYTHON_DEVELOPER_GUIDE.md up to date with the changes since #98, and greatly expands it.

Updated sections

• Installation: fresh venv first, PyPI wheels with/without [gui], installation check, Geant4 data files (download, reuse across versions, using an installed Geant4's datasets).
• Visualization, event output, reproducibility across Geant4 versions, primaries outside the world, common failure modes.

New parts

• Part VI – How the package works: the worker-process architecture, the application lifecycle, what a run records, and the event data model with units.
• Part VII – Five worked detector simulations, each run for the guide and checked against reference values, with figures in docs/images/: Rutherford gold foil (angular distribution vs Rutherford), a Pb/LAr sampling calorimeter (sampling fraction, 20%/√E resolution), proton Bragg peaks (R80 within 1% of NIST PSTAR), a magnetic spectrometer (momentum from curvature), and gamma radiography (transmission matches attenuation coefficients).
• Part VIII – Example catalogue and Part IX – API reference.
• Part X – Working on the package: layout, source builds, tests, CI, upgrading Geant4, the conda recipe, releases.

Corrections found by running the guide's code

• Scripts must create the Application under if __name__ == "__main__": (macOS starts the worker with spawn).
• detector.sensitive_volumes takes logical volume names (boxVolume, not box).
• Volume queries and check_overlaps() need initialize() first.
• Primary arrays take energy in keV and position in cm.
• With n_threads > 0, app.generator is unavailable; initialize first and use /gun/ commands.

PDF

• docs/geant4-python-developer-guide.pdf: the guide typeset with LaTeX (81 pages), linked from the README. tools/build_guide_pdf.py rebuilds it from the Markdown with tectonic (section 86). check-added-large-files now allows up to 1 MB for it.

Note: section 84 describes conda-recipe/, which is on the conda-forge-recipe branch and not yet on main.

🤖 Generated with Claude Code

[coderabbitai]

Important

• 🔍 Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

⚙️ Run configuration

• Configuration used: defaults
• Review profile: CHILL
• Plan: Advanced
• Run ID: c895faeb-a378-484c-92de-d35816c38229

• Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}