Skip to content

v0.0.1

Latest
Compare
Choose a tag to compare
@PhysiMax PhysiMax released this 25 Aug 02:34

Release notes:

  • Monte Carlo transport (absorption-only) with CLI.
  • Modules: rng, physics, simulate, cli, graph_cli.
  • Examples and plot in examples/.
  • 100% test coverage; supported on Python 3.10–3.12.

Installation

# (Optional) Create and activate a virtual environment:
python -m venv .venv
# Windows (PowerShell):
. .\.venv\Scripts\Activate.ps1
# macOS/Linux:
# source .venv/bin/activate

After cloning the repository:

cd <project-directory>
# Install the package and runtime dependencies:
pip install .
# Or install the editable version (this is also optional):
# pip install -e .[dev]

Quick Start

# Example single simulation
mctransport absorption-only -N 1e5 -d 3 -l 2 --seed 42
# Example sweep simulation with CSV/plot
mctransport-graph --N 200000 --lam 1.5 --seed 7 --dmin 0 --dmax 6 --points 25 --outdir results