Hierarchical Yield and Radionuclide Rates — isotope production in stacked target assemblies
Project description
HYRR
Hierarchical Yield and Radionuclide Rates
A pure Python package for predicting radio-isotope production in stacked target assemblies, using TENDL cross-section data and NIST stopping power tables.
Web App | Desktop App | Documentation
Try it now — full simulation runs in the browser, no install, no data leaves your machine. Need offline access? Download the desktop app for Windows, macOS, or Linux.
What it does
- Stopping power via PSTAR/ASTAR table lookup (replaces Bethe-Bloch)
- Energy-integrated production rates for any projectile (p, d, t, ³He, α)
- Bateman equations for activity, yield, and decay chains
- Compound materials with natural or enriched isotopic composition
- Stacked layer geometries (windows, targets, degraders, backings)
- Depth-resolved heat and activity profiles
Performance
HYRR is designed for interactive use — simulations are fast enough for real-time parameter sweeps:
| Operation | Time |
|---|---|
| Single isotope production rate | ~56 µs |
| Full layer simulation (all isotopes) | ~1.6 ms |
Compared to tools like Isotopia, HYRR is significantly faster and lighter: pure NumPy/SciPy with Parquet-backed nuclear data (no heavy ORM, no database server). The browser frontend achieves similar performance with a pure TypeScript compute engine.
Installation
uv add git+https://github.com/exoma-ch/hyrr.git
Quick start
from hyrr import TargetStack, Layer, Beam
stack = TargetStack(
beam=Beam(projectile="p", energy_MeV=30.0, current_mA=0.15),
layers=[
Layer(material=havar, thickness_cm=0.0025),
Layer(material=enriched_mo100, energy_out_MeV=12.0),
Layer(material=copper, thickness_cm=0.5),
],
)
result = stack.run(irradiation_time_s=86400, cooling_time_s=86400)
result.summary()
Frontend
exoma-ch.github.io/hyrr — hosted on GitHub Pages, zero backend.
The browser frontend (frontend/) is a standalone Svelte 5 + TypeScript app with a pure-TS physics engine (no Python/WASM). Nuclear data is lazy-loaded from Parquet files via hyparquet. All computation runs locally — no server, no data upload.
The physics engine is also published as @hyrr/compute (npm workspace under packages/compute/) for use in Node.js tools and the MCP server.
Key frontend features:
- Repeating layer groups — wrap layers into groups repeated N times or until beam energy drops below a threshold
- Undo/redo — Cmd+Z / Cmd+Shift+Z with 50-deep history
- Simulation mode — Auto (live) or Manual (run on demand) with status indicator
- URL sharing + sessions — full config (including groups) encoded in URL hash; session tabs persist across reloads
- Isotope filter — shared filter bar above activity plots and activity table
MCP Server
mcp/ — agent-driven irradiation analysis via the Model Context Protocol. Tools: simulate, list_materials, get_cross_sections, get_decay_data, compare_results. Resources: hyrr://libraries, hyrr://elements.
Desktop App
Download — available for Windows, macOS (Apple Silicon & Intel), and Linux.
The desktop app (desktop/) wraps the same frontend in a native window using Tauri v2. All nuclear data (~68 MB Parquet) is bundled, so it works fully offline on air-gapped machines. Built with the system webview — the installer is ~15 MB.
| Platform | Artifact |
|---|---|
| Windows 10+ | .msi installer + .exe (NSIS) |
| macOS 10.15+ | .dmg (Apple Silicon) / .dmg (Intel) |
| Ubuntu 22.04+ | .deb + .AppImage |
Releases are built automatically via GitHub Actions on version tags (v*).
Development
git clone --recurse-submodules https://github.com/exoma-ch/hyrr.git
cd hyrr
uv sync --all-extras
uv run pytest
Frontend:
cd frontend
npm ci
npm run dev
npm test # vitest
npm run check # svelte-check (TypeScript)
Desktop (requires Tauri CLI and Rust):
npm install -g @tauri-apps/cli
cd desktop && npx tauri dev
Contributing
- Fork and create a feature branch
- Python:
uv sync --all-extras, thenuv run pytestanduv run ruff check src/ - Frontend:
cd frontend && npm ci, thennpm testandnpm run check - Commit format:
type(scope): description - Open a PR against
main
Dependencies
- numpy, scipy — numerics
- polars — data access (Parquet backend)
- matplotlib — plotting
- py-mat — material definitions
- nucl-parquet — evaluated nuclear data (TENDL, ENDF/B, JENDL, JEFF, EXFOR)
About eXoma
eXoma — Exotic Matter Applications — is a research group at ETH Zürich focused on novel radioisotope production methods and targetry.
License
MIT
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file hyrr-0.7.0.tar.gz.
File metadata
- Download URL: hyrr-0.7.0.tar.gz
- Upload date:
- Size: 67.9 MB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
47eb9c46ef271142bfdc805a1133c9d7ced26b72d730ec73ae548b346fdca1d9
|
|
| MD5 |
3400c899d0cb506ca64c5f6a42038d44
|
|
| BLAKE2b-256 |
c6aa0d44e16d845cee6e5dfe19a45abef33a56e04cf998c2d2abe3552f3f8a64
|
Provenance
The following attestation bundles were made for hyrr-0.7.0.tar.gz:
Publisher:
release.yml on exoma-ch/hyrr
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
hyrr-0.7.0.tar.gz -
Subject digest:
47eb9c46ef271142bfdc805a1133c9d7ced26b72d730ec73ae548b346fdca1d9 - Sigstore transparency entry: 1189252406
- Sigstore integration time:
-
Permalink:
exoma-ch/hyrr@9d44f6fe13611de87356922e9d7848fbe34ebc01 -
Branch / Tag:
refs/tags/v0.7.0 - Owner: https://github.com/exoma-ch
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@9d44f6fe13611de87356922e9d7848fbe34ebc01 -
Trigger Event:
push
-
Statement type:
File details
Details for the file hyrr-0.7.0-py3-none-any.whl.
File metadata
- Download URL: hyrr-0.7.0-py3-none-any.whl
- Upload date:
- Size: 67.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d6d8bf9cb79030f9aeda9d841c1c98eb3961dae5190acbc2278ed7c04db642d0
|
|
| MD5 |
21850780585f6f4b21cd0f0be62dee29
|
|
| BLAKE2b-256 |
8127617b37e4984fb9537f80b4e396da3c74118262549c923fd0a12dcf24aee3
|
Provenance
The following attestation bundles were made for hyrr-0.7.0-py3-none-any.whl:
Publisher:
release.yml on exoma-ch/hyrr
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
hyrr-0.7.0-py3-none-any.whl -
Subject digest:
d6d8bf9cb79030f9aeda9d841c1c98eb3961dae5190acbc2278ed7c04db642d0 - Sigstore transparency entry: 1189252417
- Sigstore integration time:
-
Permalink:
exoma-ch/hyrr@9d44f6fe13611de87356922e9d7848fbe34ebc01 -
Branch / Tag:
refs/tags/v0.7.0 - Owner: https://github.com/exoma-ch
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@9d44f6fe13611de87356922e9d7848fbe34ebc01 -
Trigger Event:
push
-
Statement type: