adding back files to be reviewed

2026-07-24 12:05:32 -04:00 · 2019-10-28 11:55:45 -05:00 · 2019-10-28 11:55:45 -05:00 · bc09d1ef55
commit bc09d1ef55
parent ae28233110
1244 changed files with 301904 additions and 0 deletions
--- a/docs/source/pythonapi/data.rst
+++ b/docs/source/pythonapi/data.rst
@ -0,0 +1,202 @@
+--------------------------------------------
+:mod:`openmc.data` -- Nuclear Data Interface
+--------------------------------------------
+
+.. module:: openmc.data
+
+Core Classes
+------------
+
+The following classes are used for incident neutron data, decay data, fission
+and product yields.
+
+.. autosummary::
+    :toctree: generated
+    :nosignatures:
+    :template: myclass.rst
+
+    IncidentNeutron
+    Reaction
+    Product
+    FissionEnergyRelease
+    DataLibrary
+    Decay
+    FissionProductYields
+    WindowedMultipole
+    ProbabilityTables
+
+The following classes are used for storing atomic data (incident photon cross
+sections, atomic relaxation):
+
+.. autosummary::
+    :toctree: generated
+    :nosignatures:
+    :template: myclass.rst
+
+    IncidentPhoton
+    PhotonReaction
+    AtomicRelaxation
+
+
+The following classes are used for storing thermal neutron scattering data:
+
+.. autosummary::
+    :toctree: generated
+    :nosignatures:
+    :template: myclass.rst
+
+    ThermalScattering
+    ThermalScatteringReaction
+    CoherentElastic
+    IncoherentElastic
+
+
+Core Functions
+--------------
+
+.. autosummary::
+    :toctree: generated
+    :nosignatures:
+    :template: myfunction.rst
+
+    atomic_mass
+    gnd_name
+    linearize
+    thin
+    water_density
+    zam
+
+One-dimensional Functions
+-------------------------
+
+.. autosummary::
+    :toctree: generated
+    :nosignatures:
+    :template: myclass.rst
+
+    Function1D
+    Tabulated1D
+    Polynomial
+    Combination
+    Sum
+    Regions1D
+    ResonancesWithBackground
+
+Angle-Energy Distributions
+--------------------------
+
+.. autosummary::
+    :toctree: generated
+    :nosignatures:
+    :template: myclass.rst
+
+    AngleEnergy
+    KalbachMann
+    CorrelatedAngleEnergy
+    UncorrelatedAngleEnergy
+    NBodyPhaseSpace
+    LaboratoryAngleEnergy
+    AngleDistribution
+    EnergyDistribution
+    ArbitraryTabulated
+    GeneralEvaporation
+    MaxwellEnergy
+    Evaporation
+    WattEnergy
+    MadlandNix
+    DiscretePhoton
+    LevelInelastic
+    ContinuousTabular
+    CoherentElasticAE
+    IncoherentElasticAE
+    IncoherentElasticAEDiscrete
+    IncoherentInelasticAEDiscrete
+
+Resonance Data
+--------------
+
+.. autosummary::
+    :toctree: generated
+    :nosignatures:
+    :template: myclass.rst
+
+    Resonances
+    ResonanceRange
+    SingleLevelBreitWigner
+    MultiLevelBreitWigner
+    ReichMoore
+    RMatrixLimited
+    ResonanceCovariances
+    ResonanceCovarianceRange
+    SingleLevelBreitWignerCovariance
+    MultiLevelBreitWignerCovariance
+    ReichMooreCovariance
+    ParticlePair
+    SpinGroup
+    Unresolved
+
+ACE Format
+----------
+
+Classes
+++++++
+
+.. autosummary::
+    :toctree: generated
+    :nosignatures:
+    :template: myclass.rst
+
+    ace.Library
+    ace.Table
+
+Functions
+++++++++
+
+.. autosummary::
+    :toctree: generated
+    :nosignatures:
+    :template: myfunction.rst
+
+    ace.ascii_to_binary
+
+ENDF Format
+-----------
+
+Classes
+++++++
+
+.. autosummary::
+    :toctree: generated
+    :nosignatures:
+    :template: myclass.rst
+
+    endf.Evaluation
+
+Functions
+++++++++
+
+.. autosummary::
+    :toctree: generated
+    :nosignatures:
+    :template: myfunction.rst
+
+    endf.float_endf
+    endf.get_cont_record
+    endf.get_evaluations
+    endf.get_head_record
+    endf.get_tab1_record
+    endf.get_tab2_record
+    endf.get_text_record
+
+NJOY Interface
+--------------
+
+.. autosummary::
+    :toctree: generated
+    :nosignatures:
+    :template: myfunction.rst
+
+    njoy.run
+    njoy.make_pendf
+    njoy.make_ace
+    njoy.make_ace_thermal