Nucleide

Nucleide Documentation

Welcome! Nucleide is a Rust toolkit for nuclear-engineering workflow glue, exposed through a typed Python API: parse legacy code output (MCNP, Serpent, FLUKA, ALARA, and friends), build materials, and run solvers for depletion, point kinetics, enrichment cascades, spectroscopy, tritium transport, fusion neutron sources, spectrum unfolding, TBR/blanket bookkeeping, equilibrium data readers, an OpenMC statepoint tally bridge, and variance reduction — plus damage/gas metrics (dpa, appm), clearance/waste-classification screening, and uncertainty-quantification sampling. These docs are organized by audience, so you can jump straight to what you need.

Python API (nucleide) · WASM interactive tutorials Code I/O MCNP · Serpent · FLUKA ALARA · CCCC · MCPL FISPACT-II · ORIGEN · Equilibrium I/O readers, writers, emitters, translation Solvers and analysis Depletion (CRAM) · Point kinetics Enrichment · Spectroscopy · UQ sampling Variance reduction · Tritium transport Fusion sources · Spectrum unfolding Damage metrics (dpa/appm) · Clearance screening TBR/blanket bookkeeping plus the R2S workflow glue Nuclear data (nuclei) · Materials (material)

Where to start

The project README covers the full feature list, project status, and license.

Full index

Tutorials

DocumentPurpose
TutorialsTutorial index and suggested reading order
Getting startedInstall Nucleide from PyPI and run your first Python snippet
Python tutorialsPython tutorial index and suggested reading order
Parse MCNP outputRead xsdir, meshtal, MCTAL, WWINP, PTRAC, and SSW files, including the NumPy meshtal bridge
Parse Serpent outputRead Serpent _res.m, _dep.m, and _det.m output files
Parse FLUKA outputRead FLUKA USRBIN .lis tally files
Build materialsBuild materials from formulae, mix compositions, export XML, and screen dose per gram
Run depletionLoad a depletion chain and run single-step and multi-step CRAM/Bateman solves
Enrichment cascadeSet up and solve a multicomponent enrichment cascade, including standalone SWU and mass-ratio helpers
Activation analysisRead ALARA, FISPACT-II, and ORIGEN files and assemble an R2S workflow, including ARMI snapshots
Deterministic I/ORead ISOTXS and flux files and write PARTISN decks
Emit code cardsRender one material to MCNP, Serpent, FLUKA, ALARA, and PARTISN cards, including ARMI blueprint keys
Run kineticsSolve prescribed-reactivity point-kinetics transients
Run spectroscopySmooth spectra, count peaks, calibrate energy/efficiency, evaluate X-ray lines, read .spe files
MCPL particle interchangeRead and write MCPL particle lists; merge, subset, and summarize them; repair interrupted writes
UQ samplingDraw seeded MVN, log-normal, and LHS samples over caller-supplied covariance blocks and perturb decay and fission-yield data
VR and MAGICDerive weight-window lower bounds with MAGIC, emit them for OpenMC or Serpent, and sample birth voxels through alias tables
Reaction namesResolve reaction names/ids/MT numbers and walk the parent/daughter reaction graph
Translate CSGTranslate scoped MCNP CSG decks to OpenMC, Serpent, PHITS, or GDML (Geant4) geometry, with a drift report listing every approximation the translator made
Run tritiumSolve steady-state and transient 1D tritium permeation with traps and recombination boundaries
Damage metricsFold multigroup fluxes into dpa and gas production, and propagate uncertainty through the fold
Fusion sourcesBuild ring, point, and parametric tokamak neutron sources and emit MCNP/Serpent source cards
Unfold a spectrumRecover a neutron spectrum from activation detector measurements with SAND-II, least-squares, or GRAVEL adjustment, including an IRDFF response pack
Clearance screeningClassify parsed activation inventories against EU or Spanish clearance tables
Interactive tutorialsRun Nucleide in the browser through the WASM build
Interactive — nuclidesNuclide identifiers and nuclear data
Interactive — materialsFormulas, fractions, mixing, and XML export
Interactive — enrichmentSolve MARC cascades live
Interactive — depletionOne-step CRAM depletion
Interactive — MCNP I/OParse MCNP file snippets
Interactive — Serpent I/OParse Serpent _res.m, _dep.m, and _det.m output
Interactive — FLUKA I/ORead USRBIN mesh tallies from .lis files
Interactive — deck editorParse, validate, and edit full MCNP decks
Interactive — deterministic I/OISOTXS fluxes and PARTISN decks
Interactive — variance reductionMAGIC bounds and alias-table sampling
Interactive — MCPL particle listsRead and write MCPL particle lists
Interactive — code-card emissionFive-dialect card emission with a per-dialect mass-drift audit
Interactive — fusion sourcesSample D-D/D-T ring, lattice, and parametric sources (mixtures, single-fuel species pairs), emit SDEF cards, and check ECRH access
Interactive — activationALARA decks/outputs, FISPACT, R2S workflows
Interactive — clearance screeningSum-of-fractions classification against EU or Spanish limits, plus the S3–S7 radiological totals
Interactive — damage metricsFold a multigroup flux into dpa and gas production, propagate He/dpa ratio uncertainty, plus coil fast-flux and lifetime
Interactive — spectroscopySpectrum smoothing and peak counting
Interactive — spectrum unfoldingSAND-II, least-squares, and GRAVEL adjustment over detector measurements
Interactive — UQ samplingSeeded MVN sampling over caller-supplied covariance blocks (Python API and theory add log-normal + LHS)
Interactive — point kineticsStep-reactivity transients and the prompt jump
Interactive — tritium permeation1D breakthrough curve and time lag
Interactive — TBR bookkeepingRaw and effective TBR, breeding margin, and daily burn and surplus
Interactive — equilibrium dataINDATA parsing and wall-load mapping in flux coordinates

Theory

DocumentPurpose
TheoryTheory index and suggested reading order
DepletionBurnup matrices, the Bateman equation, CRAM, and time-series integrators
Enrichment cascadesMARC cascades, separation factors, and SWU
Variance reductionMAGIC weight windows, OpenMC/Serpent weight-window emission, and alias-table source sampling
Nuclear dataNuclide IDs, name dialects, masses, half-lives, and screening data
Point kineticsPrescribed-reactivity PKE system, inhour relation, prompt jump, and the stiff-aware solver
Tritium transport1D diffusion-trapping equations, McNabb–Foster traps, surface taxonomy, multi-layer series stacks with Sieverts, Henry, or vented-sink recombination interfaces, and the closed-form permeation checks
Gamma-ray spectroscopySmoothing, peak counting, energy/efficiency calibration, X-ray lines, and SPE readers
UQ-lite samplingSeeded MVN, log-normal, and LHS sampling over caller-supplied covariance blocks, SANDY-compatible estimators, and the decay perturbation consumer
Damage metricsNRT/arc-dpa displacement functions, the Lindhard partition, spectral folding conventions, He/dpa ratio uncertainty, and coil lifetime bookkeeping
Fusion neutron sourcesBallabio fusion spectra, Bosch–Hale reactivity, the Miller-geometry parametric plasma map, D-T/D-D fuel mixtures, single-fuel species temperatures, lattice sources, and ECRH accessibility
Neutron spectrum unfoldingSAND-II, least-squares, GRAVEL, and maximum-entropy adjustment, convergence, and underdetermined systems
Clearance screeningClearance index, the sum-of-fractions rule, the Sublet S1–S7 totals, and the EU and Spanish clearance tables
TBR and blanket bookkeepingRaw TBR, port-penalty haircuts, energy multiplication, burn rate, and breeding margins
Equilibrium data readersClassic-netCDF wout reading, the INDATA grammar, flux-surface Jacobians, and wall-load mapping

Reference

DocumentPurpose
ReferenceReference index and quick links
Crate overviewOne-line responsibilities for every workspace crate
Python APIPython facade overview and module map
Sample data filesIndex of the sample files the test suite reads, with per-file source links

Development

DocumentPurpose
Local developmentToolchain, local build, test, and lint commands
ContributingBranch workflow, commit style, and PR checklist
Cross-code validationReproduce the PyNE/OpenMC validation harness and measured tables

Architecture

DocumentPurpose
Architecture overviewHigh-level system overview and layer boundaries
Crate responsibilitiesCrate-level responsibilities and dependency rules

Plan

DocumentPurpose
RoadmapCurrent status and upcoming priorities
Decision logArchitecture and process decisions with rationale

See the project AGENTS.md for ownership and contract details. Rules for maintaining these docs live in Contributing.