Add format spec for depletion results HDF5 file (add necessary attributes too)

docs/source/io_formats/depletion_chain.rst

@@ -1,4 +1,4 @@
-.. _io_chain:
+.. _io_depletion_chain:
 
 ============================
 Depletion Chain -- chain.xml

docs/source/io_formats/depletion_results.rst

@@ -0,0 +1,42 @@
+.. _io_depletion_results:
+
+=============================
+Depletion Results File Format
+=============================
+
+The current version of the depletion results file format is 1.0.
+
+**/**
+
+:Attributes: - **filetype** (*char[]*) -- String indicating the type of file.
+             - **version** (*int[2]*) -- Major and minor version of the
+               statepoint file format.
+
+:Datasets: - **eigenvalues** (*float[][]*) -- k-eigenvalues at each
+             time/stage. This array has shape (number of timesteps, number of
+             stages).
+           - **number** (*float[][][][]*) -- Total number of atoms. This array
+             has shape (number of timesteps, number of stages, number of
+             materials, number of nuclides).
+           - **reaction rates** (*float[][][][][]*) -- Reaction rates used to
+             build depletion matrices. This array has shape (number of
+             timesteps, number of stages, number of materials, number of
+             nuclides, number of reactions).
+           - **time** (*float[][2]*) -- Time in [s] at beginning/end of each
+             step.
+
+**/materials/<id>/**
+
+:Attributes: - **index** (*int*) -- Index used in results for this material
+             - **volume** (*float*) -- Volume of this material in [cm^3]
+
+**/nuclides/<name>/**
+
+:Attributes: - **atom number index** (*int*) -- Index in array of total atoms
+               for this nuclide
+             - **reaction rate index** (*int*) -- Index in array of reaction
+               rates for this nuclide
+
+**/reactions/<name>/**
+
+:Attributes: - **index** (*int*) -- Index user in results for this reaction

docs/source/io_formats/index.rst

@@ -12,7 +12,7 @@ Input Files
 
 .. toctree::
    :numbered:
-   :maxdepth: 2
+   :maxdepth: 1
 
    geometry
    materials
@@ -27,7 +27,7 @@ Data Files
 
 .. toctree::
    :numbered:
-   :maxdepth: 2
+   :maxdepth: 1
 
    cross_sections
    depletion_chain
@@ -42,11 +42,12 @@ Output Files
 
 .. toctree::
    :numbered:
-   :maxdepth: 2
+   :maxdepth: 1
 
    statepoint
    source
    summary
+   depletion_results
    particle_restart
    track
    voxel