nucl-parquet 0.13.6

Nuclear data as Parquet — zero-copy cross-section lookups for Monte Carlo transport
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73

//! # nucl-parquet
//!
//! Fast, thread-safe access to nuclear interaction data stored as Parquet files.
//!
//! Designed as the physics data backbone for Monte Carlo particle transport codes.
//! All data structures are `Send + Sync` — load once, share across threads via `Arc`.
//!
//! ## Data sources
//!
//! - **EPDL97**: Photon cross-sections (photoelectric, Compton, Rayleigh, pair production)
//! - **EADL**: Atomic relaxation (fluorescence X-ray and Auger transition probabilities)
//! - **EEDL**: Electron cross-sections (elastic, bremsstrahlung, ionization)
//! - **XCOM**: Total mass attenuation coefficients (µ/ρ, µ_en/ρ)
//! - **Stopping**: NIST PSTAR/ASTAR/ESTAR + dSTAR/tSTAR and CatIMA mass stopping power tables
//! - **Meta**: Isotopic abundances, radioactive decay chains, and dose rate constants
//! - **XS**: Nuclear reaction cross-sections (TENDL and other evaluated libraries)
//!
//! ## Usage
//!
//! ```no_run
//! use nucl_parquet::PhotonDb;
//! use std::sync::Arc;
//!
//! # fn main() -> nucl_parquet::Result<()> {
//! let db = Arc::new(PhotonDb::open("path/to/nucl-parquet/meta")?);
//!
//! // Thread-safe lookups (no locks, data is immutable)
//! let xs = db.cross_section(29, 511.0, nucl_parquet::Process::Photoelectric);
//! let ff = db.form_factor(29, 0.5);  // Rayleigh form factor at q=0.5
//! # Ok(())
//! # }
//! ```
//!
//! ## Quick start (with `fetch` feature)
//!
//! ```ignore
//! // requires `fetch` feature
//! let data = nucl_parquet::DataDir::ensure()?;
//! let photon = data.photon_db()?;
//! ```

mod data_dir;
mod electron;
mod error;
mod interp;
mod meta;
mod photon;
mod relaxation;
mod stopping;
pub mod store;
mod subshell_pe;
mod xcom;
mod xs;

pub use data_dir::DataDir;
pub use electron::{ElectronDb, ElectronProcess};
pub use error::Error;
pub use interp::XYTable;
pub use meta::{
    z_to_symbol, AbundanceEntry, AbundancesDb, CoincidenceEntry, CoincidenceFilter, CoincidencesDb,
    DecayDb, DecayEntry, DoseConstant, DoseDb, Emission, EmissionEntry, GammaCandidate,
    RadiationDb,
};
pub use photon::{PhotonDb, Process};
pub use relaxation::{RelaxationDb, Transition, TransitionType};
pub use stopping::StoppingDb;
pub use store::{Filter, ParquetStore};
pub use subshell_pe::SubshellPeDb;
pub use xcom::XcomDb;
pub use xs::{CrossSectionDb, XsEntry};

/// Result type for nucl-parquet operations.
pub type Result<T> = std::result::Result<T, Error>;