nook

nook: nuclear level schemes from ENSDF.

Two backends behind one data model – the IAEA Livechart API for adopted levels, the NNDC flat files for every evaluated dataset. See docs/usage.md.

nook.SOURCE_ALIASES = {'api': 'livechart', 'ensdf': 'file', 'flat': 'file', 'iaea': 'livechart', 'ripl': 'ripl3'}

Accepted spelling -> canonical source name. Every dispatcher that takes a source string (here, compare) resolves through this one map.

nook.level_scheme(nuclide, source='livechart', dataset=None, with_gammas=True, cache=None, path=None)

Fetch a level scheme for nuclide ("24Mg", "Mg-24", (12, 24)).

source is "livechart" for the IAEA API, which serves adopted levels only; "file" for local flat files, where dataset picks one evaluation by DSID substring; or "ripl3" for the committed RIPL-3 mirror (levels cut 2021, derived from ENSDF).

nook.decay_schemes(nuclide, path=None)

Every decay dataset populating nuclide, from local ENSDF files.

Decay data is only available from the flat files; the Livechart API serves adopted levels alone.

nook.ground_state(nuclide, source='livechart', cache=None, path=None)

Mass, abundance, charge radius and moments for nuclide.

source="livechart" aggregates AME, NUBASE, charge radii and moment compilations (see nook.EVALUATIONS for attribution and nook.UNITS for units – atomic_mass is in micro-u, not u). source="ripl3" serves the sparser RIPL-3 mass tables: mass excess and abundance, with FRDM95/HFB-14 theory values in metadata. The ENSDF flat files carry none of this.

Modules

cache	A tiny on-disk cache for remote responses.
cli	Command line front end: nook levels 24Mg --below 10000.
compare	Cross-source comparison: levels and masses where the backends overlap.
decay	Decay datasets: parent, normalisation and feeding records.
groundstate	Ground-state properties: masses, abundances, radii and moments.
model	The data model returned by every source backend.
nuclide	Nuclide identifiers: parsing, normalisation and ENSDF NUCID handling.
plotting	Publication-quality figures for level, band and decay schemes.
quantities	Parsing of ENSDF-flavoured physical quantities.
repair(states[, max_passes])	Correct transcription errors that the mass surface can confirm.
sources	Backends that can produce a LevelScheme.
survey([path, cache, mass_range])	Ground states for every nuclide in a local ENSDF distribution.