Installation¶
For most users¶
pip install primat
That’s it. The package includes a fast C backend compiled for your platform, with a pure-Python fallback if no compiled binary is available — both give identical results, just different speed. To get started, just type
primat --help
Core dependencies¶
Package |
Role |
|---|---|
|
Mandatory (installed by |
|
JIT compilation gives ~5× speedup on rate kernels |
|
Monte Carlo integration for thermal weak-rate corrections |
|
Parallel Monte-Carlo ( |
joblib and plotly are not mandatory — they live in extras so a lean
pip install primat core (numpy + scipy) is enough to install and solve.
Optional extras¶
Pick an extra by use case:
Extra |
|
Adds |
|---|---|---|
|
|
fast kernels + thermal-rate integrator + parallel MC |
|
|
parallel Monte-Carlo only |
|
|
interactive plotting (used by the GUI figures) |
|
|
the |
|
|
the example notebooks |
|
|
building this documentation site |
|
everything above except |
one-shot full install |
pip install "primat[recommended]"
GUI¶
pip install "primat[gui]"
primat-gui
Package |
Role |
|---|---|
|
Required for |
|
Required for |
|
Required for |
See Custom networks (GUI zip and API) for what the GUI adds beyond the CLI/API.
Notebooks¶
pip install -e ".[notebooks]"
Package |
Role |
|---|---|
|
Plotting and tabular display in the notebooks |
|
Headless notebook re-execution (used by the nightly docs build) |
See Tutorials for the notebook gallery.
From source¶
git clone https://github.com/CyrilPitrou/primat
cd primat
pip install -e ".[recommended]"
For users who prefer to work directly with the C code, primat-c/ is a
standalone C99 implementation that builds independently via make — see
primat-c/README.md in the repository for compilation instructions.