mirror of
https://github.com/pim-n/pg-rad
synced 2026-03-10 19:48:12 +01:00
f49b2a5f8a
- Added mass attenuation interpolator - PG fluence rate function that can be called at any position in the landscape - Rewrote landscape module to pseudo-builder pattern (LandscapeBuilder & LandscapeConstructor) - Added entry point (CLI) - Verified installation process and updated instructions accordingly - Updated tests - various bugfixes - various minor improvements
pg-rad
Primary Gamma RADiation landscape - Development
Clone
git clone https://github.com/pim-n/pg-rad
cd pg-rad
git checkout dev
or
git@github.com:pim-n/pg-rad.git
cd pg-rad
git checkout dev
Dependencies / venv
With Python verion >=3.12.4 and <3.13, create a virtual environment and install pg-rad.
python3 -m venv .venv
source .venv/bin/activate
With the virtual environment activated, run:
pip install -e .[dev]
Running example landscape
The example landscape can be generated using the command-line interface. Still in the virtual environment, run
pgrad --test --loglevel DEBUG
Tests
Tests can be run with pytest from the root directory of the repository. With the virtual environment activated, run:
pytest
Local viewing of documentation
PG-RAD uses Material for MkDocs for generating documentation. It can be locally viewed by (in the venv) running:
mkdocs serve
where you can add the --livereload flag to automatically update the documentation as you write to the Markdown files.