Skip to main content

YANI

Yet Another Nuclide Inventory. A material, an irradiation schedule and a neutron spectrum in; inventories, activities, decay heat, contact dose, decay photon spectra and displacement damage (dpa) out. One call can solve many materials at once, such as the cells of a mesh, and the result can be checked against regulatory clearance and disposal limits.

Try it online 🌐 | Documentation 📝 | Validation 📊 | PyPI 🐍

The browser version needs no install and no account. It is the same Rust solver compiled to WebAssembly, against the same continuous-energy data, so it answers what the wheel answers rather than a reduced version of it. The solve runs on your machine; nothing is uploaded.

pip install yani
import yani

# flexible use of different libraries
yani.neutron_cross_section_data = "tendl-2025"
yani.transmutation_reactions = "tendl-2025"
yani.transmutation_branch_ratios = "tendl-2025"
yani.transmutation_decay_data = "endf-b8.1"
yani.transmutation_fission_yields = "endf-b8.1"

# make your own or use inbuilt material definitions
steel = yani.materials.pnnl.material(key="Steel, Stainless 316", volume=1000.0)

# define the neutron spectrum
spectrum = yani.NeutronSource(
    energy=yani.sources.Histogram(
        boundaries=[1e-5, 1e5, 1e6, 1.5e7], probabilities=[1e12, 1e13, 1e14]
    )
)

# define the irradiation and cooling schedule
schedule = yani.PulseSchedule(steps=[
    yani.Pulse(rate=1.11e14, duration=(1, "a"), source=spectrum),
    yani.Cooldown(duration=(1, "d")),
])

# perform the simulation
results = steel.transmute(schedule=schedule)

# access the last material in the time steps (results are keyed by material id)
final = results.step_materials(material_id=steel.id)[-1]

# convenient access to useful properties of the material
print(final.activity(), "Bq")
print(final.decay_heat(), "W")
print(final.contact_dose(), "Gy/h")

What it solves

The nuclide inventory under irradiation is the Bateman equations with reaction terms, dN/dt = A N, solved as a matrix exponential N(t) = exp(A t) N(0) by CRAM at order 48. The solver is Rust; the wheel needs no compiler and no external toolchain.

Getting the spectrum

If you do not have a neutron spectrum for the material yet, YAMC computes one by Monte Carlo transport through your geometry. It uses the same materials, schedules and nuclear data, and can run the transmutation coupled to the transport.

Licence

Dual-licensed under either of

at your option.

Metadata

Release files for yani 0.31.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for yani 0.31.0
File Size Uploaded Provenance Actions
yani-0.31.0.tar.gz 7.1 kB With provenance Details for yani-0.31.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for yani 0.31.0
File Interpreter ABI Platform Actions
yani-0.31.0-py3-none-any.whl Python 3 none any Details for yani-0.31.0-py3-none-any.whl

Total release size: 14.5 kB

Release files / yani-0.31.0.tar.gz

Download URL yani-0.31.0.tar.gz
Size 7.1 kB
Tags Source
SHA-256 checksum
How to use checksums
04c5e7947fb0209d9675e27c1ee642a5b08e39eb9373162443588e2db3efd19c
BLAKE2b-256 checksum
How to use checksums
556c6bfa07c6cca83a1bf9a6c96ae585a72bdf700c21ad1a027946e57f2dc393
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 20, 2026.

Transparency log

Release files / yani-0.31.0-py3-none-any.whl

Download URL yani-0.31.0-py3-none-any.whl
Size 7.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
9654694cfa78382445b7324fa0da0b1625fcea30cf40b2d30fd6ef4bf83ab5e0
BLAKE2b-256 checksum
How to use checksums
934efc1d3831be9bb6d5a8ddd0343d324803923215745878bd6744512d2fbc4e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 20, 2026.

Transparency log

Security for yani 0.31.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for yani-0.31.0.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 20, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.31.0 This release

2 release files Full provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page