Skip to main content

yani-core

Yet Another Nuclide Inventory: transmutation and activation without transport. A material, an irradiation schedule and a neutron spectrum in; inventories, activities, decay heat and hydrogen and helium gas production out.

This is the compiled distribution, and it provides the yani module itself, so the import name and the distribution name differ (as pillow provides PIL). Install yani rather than this: it pins the matching version of this wheel and is where the documentation lives.

import yani

yani.neutron_cross_section_data = "endf-b8.1"
yani.transmutation_decay_data = "endf-b8.1"
yani.transmutation_reactions = "endf-b8.1"
yani.transmutation_fission_yields = "endf-b8.1"

steel = yani.materials.pnnl.material("Steel, Stainless 316", volume=1000.0)
spectrum = yani.NeutronSource(
    energy=yani.sources.Histogram([1e-5, 1e5, 1e6, 1.5e7], [1e12, 1e13, 1e14])
)
schedule = yani.PulseSchedule([
    yani.Pulse(rate=1.11e14, duration=(1, "a"), source=spectrum),
    yani.Cooldown(duration=(1, "d")),
])

results = steel.transmute(schedule=schedule)
final = results.get_final_material(steel.id)
print(final.activity(), "Bq")
print(final.decay_heat(), "W")
print(final.contact_dose(), "Gy/h")
print(final.clearance_index("UK_EPR16_out_of_scope").index)
print(results.get_gas_production(steel.id)["He"], "appm He")

Each setting takes a library keyword or a local folder, and none has a default: a calculation that reads one that is unset is refused before any work, naming it. transmutation_reactions and transmutation_fission_yields also take False, which leaves that subsection out of a material with no reaction rates, or one in which nothing fissions.

Cross-section selection

neutron_cross_section_data supplies the neutron reaction rates for irradiation. It accepts a library keyword, an existing local directory, or a nuclide-to-source mapping. A new assignment replaces the selection; None and an empty mapping unset it. No map entry becomes a default for unrelated nuclides.

The independent photon_cross_section_data setting is also available for a consistent data interface between the wheels, but standalone YANI inventory solves do not transport photons and do not read it. Contact-dose estimates use the selected decay data and bundled response tables, not photon transport data. A decay-only schedule needs neither cross-section setting. The existing transmutation_* settings remain independent, so selecting FENDL neutron data does not silently choose another library for decay or fission yields.

Displacement damage comes from the same call: pass displacement_damage=True for the damage energy per atom and NRT dpa over the schedule, per element and for the material.

tungsten = yani.Material({"W": 1.0}, density=19.3)
results = tungsten.transmute(schedule=schedule, displacement_damage=True)
results.get_dpa(0)  # cumulative, one value per state
results.get_dpa(0, element="W")
results.get_damage_energy(0)  # eV per atom, the model-free input
results.get_displacement_damage_info(0)["displacement_energies"]

Given data_uncertainty as well, get_dpa_uncertainty(0, step) and get_damage_energy_uncertainty(0, step) return the spread: each replica moves the damage energy through its drawn cross sections (each reaction's deposit times its change, elastic and inelastic included), its flux spectrum and its own composition.

The displacement threshold energies default to ASTM E521, and to the OECD-NEA 2015 report "Primary Radiation Damage in Materials" (NEA/NSC/DOC(2015)9) for elements E521 does not cover; override any of them with displacement_energies={"Fe": 40.0}. An element in neither source must be given, and is never guessed.

Isomeric branching

Which state a reaction leaves its product in, In115 (n,n') making In115m rather than In115, comes from a branching evaluation laid over the chain with transmutation_branch_ratios: the branching evaluation gives each reaction's split and the cross-section library its total. It takes one source, or several in order, and each reaction takes its split, and the MF=40 covariance of that split, from the first source that evaluates it.

yani.neutron_cross_section_data = "endf-b8.1"
yani.transmutation_decay_data = "endf-b8.1"
yani.transmutation_reactions = "endf-b8.1"
yani.transmutation_fission_yields = "endf-b8.1"
yani.transmutation_branch_ratios = ["irdff-ii", "endf-b8.1"]

foil = yani.Material({"Nb93": 1.0}, density=8.57, volume=1.0)
results = foil.transmute(schedule=schedule)
report = results.get_branching_report(foil.id, 0)
[(c["reaction"], c["source"]) for c in report["channels"] if c["parent"] == "Nb93"]
# [('(n,2n)', 'irdff-ii'), ('(n,gamma)', 'irdff-ii'), ("(n,n')", 'irdff-ii')]
report["mixed"]  # True: IRDFF-II splits on ENDF/B-VIII.1 totals

irdff-ii is the IAEA International Reactor Dosimetry and Fusion File, IRDFF-II, whose isomer production is evaluated for dosimetry: In115 (n,n') In115m, In115 (n,2n) In114m, Nb93 (n,n') Nb93m and Nb93 (n,2n) Nb92m are among its 14 channels. It publishes isomeric branching and nothing else, so it is only ever a branching source (naming it as neutron_cross_section_data or any other transmutation source is refused), and it is used only where it is named.

The branching report names the source of every channel, and mixed says whether a run takes its splits from more than one library, or a split from a library other than its total's.

MT=5 residual data

MT=5, (n,anything), can remove a parent through several unresolved reaction channels. Its light-particle yields alone do not identify the residual nuclei or their isomeric states. If those products are missing, yani continues and prints a warning when the unmodelled MT=5 contribution exceeds 0.1% of the material's neutron removal rate. Parent removal and evaluated light-particle production are retained, but the missing residual nuclei are not produced. The returned inventory is incomplete; that fraction does not bound the error in activity or decay heat. No residuals are invented and no libraries are substituted. The impossible-yield and out-of-range branching guards still refuse invalid calculations as before.

ENDF/B-VIII.1 gives no heavy MT=5 residual products for Tm169, Zr90, Zr91, Zr92, Zr94 or Zr96: their MF=6 MT=5 sections contain neutrons, light particles and photons, and none has MF=9 or MF=10 MT=5 production to supply the missing residuals. The endf-b8.1 release 2026-10-12.1 records all six under mt5.residual_not_given in the reactions provenance. Re-converting these evaluations cannot recover absent products; the processed release preserves the omissions, and republishing the same evaluations will not repair them. Raising the allowance, retaining removed parents or normalising the gas yields into residuals would not account for the missing inventory.

These compositions can be solved with that ENDF/B-VIII.1 configuration, with the warning and missing residuals recorded by results.get_branching_report(material.id, 0)["unmodelled_mt5"] for the first irradiation interval. Inspect each interval's report when the spectrum changes. The 0.1% value is a warning threshold for missing MT=5 residuals, not permission to treat the returned inventory as complete.

To use a different residual-production model, select a different neutron library together with its reaction and branching data. For example, use TENDL-2025 for all three, while retaining explicitly selected ENDF/B-VIII.1 decay data and fission yields:

import yani

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"

source = yani.NeutronSource(
  energy=yani.sources.Histogram([14.0e6, 14.2e6], [1.0])
)
schedule = yani.PulseSchedule([
  yani.Pulse(duration=(300, "s"), rate=1.116e10, source=source),
  yani.Cooldown(duration=(60, "s")),
])
zirconium = yani.Material(
  {"Zr": 1.0}, fraction_type="mass", density=6.52, volume=1.0 / 6.52,
  temperature=294.0,
)
results = zirconium.transmute(schedule)
print(results.data_releases)
print(results.get_branching_report(zirconium.id, 0)["mixed"])

Make a new material after selecting the sources. The same selection applies to the thulium-oxide composition. Both nominal cases were checked with TENDL release 2026-10-18 and ENDF/B release 2026-10-12.1. This is a TENDL neutron/reaction calculation with ENDF/B decay and fission-yield data, not an ENDF/B neutron result or an ENDF/B data repair. Changing only the reaction or branching source instead borrows a different residual-production model; it must not be presented as the original library's prediction.

An ENDF/B warning run remains ENDF/B-based, but its missing products and incomplete inventory must be stated in a comparison. An alternative-library calculation cannot fill an ENDF/B-labelled result cell. A comparison requiring complete residual production must still flag these ENDF/B cases as unsupported.

Record data_releases and the branching report for each result. When a source changes, repeat the affected calculations rather than combining old and new values under one library label. Unchanged solves may be retained only with their original provenance. A successful solve alone does not validate its decay-heat prediction.

Relationship to yamc

yamc is a superset: it ships everything here plus neutron and photon transport, geometry, tallies and transport-coupled transmutation. The two are alternatives. Installing both puts two extension modules in one process, so yamc.Material and yani.Material are distinct types and the nuclear-data configuration (neutron_cross_section_data, the four transmutation_* sources) exists twice, once per package.

Pick yani when you have a spectrum already and want none of the transport stack; pick yamc when the spectrum should come from a transport solve.

What it does not do

  • One stepper (ForwardEulerStepper, beginning-of-step rates). No predictor-corrector.
  • Uncertainty is by resampling: pass data_uncertainty=yani.DataUncertainty() to transmute for a standard deviation on inventories, activity, decay heat, dose and gas production. It perturbs MF=33 cross sections, MF=32 resonance parameters (drawn per replica and the resonance cross sections rebuilt from them, where the library publishes them, and otherwise their first-order group covariance), half-lives, decay energies, decay photon line intensities and energies, two-mode decay branching, the isomeric split of each reaction whose final states carry an MF=40 covariance, and a supplied flux spectrum's stated error. Other inputs (the self-shielding correction, the material composition) are held at nominal, and get_data_uncertainty_info lists every one it held. There are no first-order sensitivity coefficients.
  • The decay data do not state how a nuclide's photon line intensities are correlated (between lines, between a spectrum's normalisation and its lines, between its gamma and x-ray spectra), and ENDF/B-VIII.1 folds each spectrum's normalisation sigma into every line's. So a photon spectrum, contact dose or decay heat is reported as a range rather than assumed: Estimate.std_dev takes those correlations as zero and Estimate.std_dev_correlated as one, which bounds every non-negative correlation. get_data_uncertainty_info()["decay_photon_spectra_folded"] names the spectra the range mostly comes from.
  • Replicas are added 64 at a time until every tracked sigma (each nuclide density within 1e-6 of the largest, and the total activity, decay heat and decay photon line rate, at every step) has a standard error under 5% of itself, set with DataUncertainty(convergence=...). The standard error carries the sample kurtosis, so a heavy-tailed output needs more replicas than a Gaussian one (about 201 at 5%). At least 128 and at most 1024 run; a run that stops on the cap says so (hit_cap) and lists the outputs that missed (unconverged).
  • Damage energy and dpa carry no uncertainty yet: MT=444 has no covariance, and the flux and composition replicas are not folded into it.
  • Pathways are reported per product (get_production_routes), but there is no automatic pathway search across the whole inventory.
  • No ingestion or inhalation dose.
  • Cross sections are read from the continuous-energy library and collapsed against your spectrum, so this reads transport-format data files even though it runs no transport. Only the sections activation needs are read, which is a small fraction of a library.

Metadata

Release files for yani-core 0.25.0

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

Built distributions (wheels)

Table of built distributions (wheels) for yani-core 0.25.0
File Actions
yani_core-0.25.0-cp310-abi3-win_amd64.whl CPython 3.10 abi3 Windows x86-64 Details for yani_core-0.25.0-cp310-abi3-win_amd64.whl
yani_core-0.25.0-cp310-abi3-pyemscripten_2026_0_wasm32.whl CPython 3.10 abi3 PyEmscripten 2026.0+ WebAssembly Details for yani_core-0.25.0-cp310-abi3-pyemscripten_2026_0_wasm32.whl
yani_core-0.25.0-cp310-abi3-manylinux2014_x86_64.manylinux_2_17_x86_64.whl CPython 3.10 abi3 Linux glibc 2.17+ x86-64 Details for yani_core-0.25.0-cp310-abi3-manylinux2014_x86_64.manylinux_2_17_x86_64.whl
yani_core-0.25.0-cp310-abi3-manylinux2014_aarch64.manylinux_2_17_aarch64.whl CPython 3.10 abi3 Linux glibc 2.17+ ARM64 Details for yani_core-0.25.0-cp310-abi3-manylinux2014_aarch64.manylinux_2_17_aarch64.whl
yani_core-0.25.0-cp310-abi3-macosx_11_0_arm64.whl CPython 3.10 abi3 macOS 11.0+ ARM64 Details for yani_core-0.25.0-cp310-abi3-macosx_11_0_arm64.whl

Total release size: 42.1 MB

Release files / yani_core-0.25.0-cp310-abi3-win_amd64.whl

Download URL yani_core-0.25.0-cp310-abi3-win_amd64.whl
Size 9.8 MB
Tags CPython 3.10 Windows x86-64 abi3
SHA-256 checksum
How to use checksums
3dd186d3b64f5a0ec4074465ab64583a015d21466fd055a721121092a410a0c2
BLAKE2b-256 checksum
How to use checksums
8a5907d39f2ccd608be2b8ef1edc3b716b640dc53209650b73ae93faeb75f42a
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 12, 2026.

Transparency log

Release files / yani_core-0.25.0-cp310-abi3-pyemscripten_2026_0_wasm32.whl

Download URL yani_core-0.25.0-cp310-abi3-pyemscripten_2026_0_wasm32.whl
Size 4.4 MB
Tags CPython 3.10 PyEmscripten 2026.0+ WebAssembly abi3
SHA-256 checksum
How to use checksums
492bbbc7de83386d5add1eef69c28deee206afbdb1d5da4e4c1796b1a1707a9e
BLAKE2b-256 checksum
How to use checksums
be91e855d3d1d72ae7ce688ea65241687199a58ace1d9a298489a50657392ead
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 12, 2026.

Transparency log

Release files / yani_core-0.25.0-cp310-abi3-manylinux2014_x86_64.manylinux_2_17_x86_64.whl

Download URL yani_core-0.25.0-cp310-abi3-manylinux2014_x86_64.manylinux_2_17_x86_64.whl
Size 10.0 MB
Tags CPython 3.10 Linux glibc 2.17+ x86-64 abi3
SHA-256 checksum
How to use checksums
4fd08b37e1a2c84cef83aba7084d1c65533ac72dfcd33a98a646dec9af1167e4
BLAKE2b-256 checksum
How to use checksums
ac751eec87bdfc7d399470f7922217df8504199585368fe95e68414ef30b14f9
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 12, 2026.

Transparency log

Release files / yani_core-0.25.0-cp310-abi3-manylinux2014_aarch64.manylinux_2_17_aarch64.whl

Download URL yani_core-0.25.0-cp310-abi3-manylinux2014_aarch64.manylinux_2_17_aarch64.whl
Size 9.1 MB
Tags CPython 3.10 Linux glibc 2.17+ ARM64 abi3
SHA-256 checksum
How to use checksums
cc79be1941a57b86fa880cd127f23b6a5de18298b89a8b5c1260837773baddc8
BLAKE2b-256 checksum
How to use checksums
0fe154baf8ecda5784ed9a6d55120cd8f11d834d17266430ae0029d2cfa61fa1
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 12, 2026.

Transparency log

Release files / yani_core-0.25.0-cp310-abi3-macosx_11_0_arm64.whl

Download URL yani_core-0.25.0-cp310-abi3-macosx_11_0_arm64.whl
Size 8.7 MB
Tags CPython 3.10 abi3 macOS 11.0+ ARM64
SHA-256 checksum
How to use checksums
2f08c7ebeb236e495042cd950f4af558a6a98ae03683d1bae3d4fb1652c07997
BLAKE2b-256 checksum
How to use checksums
a7136e4c455f6ba4d9d2f3617cd126932d599d884f2cd39eb29cc24fcc171ed3
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 12, 2026.

Transparency log

Security for yani-core 0.25.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

All 5 files in this release have been uploaded with provenance metadata.

Select from 5 files

Attestation for yani_core-0.25.0-cp310-abi3-win_amd64.whl

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 12, 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.

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