diff --git a/docs/source/conf.py b/docs/source/conf.py index 4a18f14de..05559aab0 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -27,6 +27,7 @@ sys.path.insert(0, os.path.abspath('../..')) extensions = ['sphinx.ext.autodoc', 'sphinx.ext.napoleon', 'sphinx.ext.pngmath', + 'sphinx.ext.autosummary', 'sphinxcontrib.tikz', 'sphinx_numfig', 'notebook_sphinxext'] diff --git a/docs/source/pythonapi/mgxs.rst b/docs/source/pythonapi/mgxs.rst index 04e2a99de..c7084e565 100644 --- a/docs/source/pythonapi/mgxs.rst +++ b/docs/source/pythonapi/mgxs.rst @@ -4,5 +4,63 @@ Multi-Group Cross Sections ========================== -.. automodule:: openmc.mgxs.mgxs - :members: MGXS +.. currentmodule:: openmc.mgxs.mgxs + +---------------------------- +Summary of Available Classes +---------------------------- + +.. autosummary:: + + MGXS + AbsorptionXS + CaptureXS + Chi + FissionXS + NuFissionXS + NuScatterXS + NuScatterMatrixXS + ScatterXS + ScatterMatrixXS + TotalXS + TransportXS + +------------------- +Class Documentation +------------------- + +.. autoclass:: MGXS + :members: + +.. autoclass:: AbsorptionXS + :members: + +.. autoclass:: CaptureXS + :members: + +.. autoclass:: Chi + :members: + +.. autoclass:: FissionXS + :members: + +.. autoclass:: NuFissionXS + :members: + +.. autoclass:: NuScatterXS + :members: + +.. autoclass:: NuScatterMatrixXS + :members: + +.. autoclass:: ScatterXS + :members: + +.. autoclass:: ScatterMatrixXS + :members: + +.. autoclass:: TotalXS + :members: + +.. autoclass:: TransportXS + :members: diff --git a/docs/source/pythonapi/opencg_compatible.rst b/docs/source/pythonapi/opencg_compatible.rst index c8ba82e8c..c807e19cc 100644 --- a/docs/source/pythonapi/opencg_compatible.rst +++ b/docs/source/pythonapi/opencg_compatible.rst @@ -1,8 +1,8 @@ -.. _pythonapi_openmc_mgxs: +.. _pythonapi_opencg_compatible: -========================== -Multi-Group Cross Sections -========================== +==================== +OpenCG Compatibility +==================== -.. automodule:: openmc.mgxs.mgxs +.. automodule:: openmc.opencg_compatible :members: diff --git a/openmc/filter.py b/openmc/filter.py index 8a5525233..5c0343df7 100644 --- a/openmc/filter.py +++ b/openmc/filter.py @@ -511,8 +511,9 @@ class Filter(object): surface, material or universe ID corresponding to each filter bin. For 'distribcell' filters, the DataFrame either includes: - 1) a single column with the cell instance IDs (without summary info) - 2) separate columns for the cell IDs, universe IDs, and lattice IDs + + 1. a single column with the cell instance IDs (without summary info) + 2. separate columns for the cell IDs, universe IDs, and lattice IDs and x,y,z cell indices corresponding to each (with summary info). For 'energy' and 'energyout' filters, the DataFrame include a single diff --git a/openmc/mgxs/library.py b/openmc/mgxs/library.py index 215b4f12e..13537848e 100644 --- a/openmc/mgxs/library.py +++ b/openmc/mgxs/library.py @@ -324,9 +324,7 @@ class Library(object): ---------- domain : Material or Cell or Universe or Integral The material, cell, or universe object of interest (or its ID) - mgxs_type : {'total', 'transport', 'absorption', 'capture', 'fission', - 'nu-fission', 'scatter', 'nu-scatter', 'scatter matrix', - 'nu-scatter matrix', 'chi'} + mgxs_type : {'total', 'transport', 'absorption', 'capture', 'fission', 'nu-fission', 'scatter', 'nu-scatter', 'scatter matrix', 'nu-scatter matrix', 'chi'} The type of multi-group cross section object to return Returns diff --git a/openmc/mgxs/mgxs.py b/openmc/mgxs/mgxs.py index f0aa9d618..7c2156c19 100644 --- a/openmc/mgxs/mgxs.py +++ b/openmc/mgxs/mgxs.py @@ -258,9 +258,7 @@ class MGXS(object): Parameters ---------- - mgxs_type : {'total', 'transport', 'absorption', 'capture', 'fission', - 'nu-fission', 'scatter', 'nu-scatter', 'scatter matrix', - 'nu-scatter matrix', 'chi'} + mgxs_type : {'total', 'transport', 'absorption', 'capture', 'fission', 'nu-fission', 'scatter', 'nu-scatter', 'scatter matrix', 'nu-scatter matrix', 'chi'} The type of multi-group cross section object to return domain : Material or Cell or Universe The domain for spatial homogenization @@ -338,8 +336,8 @@ class MGXS(object): """Get the atomic number density in units of atoms/b-cm for a nuclide in the cross section's spatial domain. - Paramters - --------- + Parameters + ---------- nuclide : str A nuclide name string (e.g., 'U-235') @@ -373,8 +371,8 @@ class MGXS(object): """Get an array of atomic number densities in units of atom/b-cm for all nuclides in the cross section's spatial domain. - Paramters - --------- + Parameters + ---------- nuclides : Iterable of str or 'all' or 'sum' A list of nuclide name strings (e.g., ['U-235', 'U-238']). The special string 'all' will return the atom densities for all nuclides diff --git a/openmc/tallies.py b/openmc/tallies.py index 03aa8e3a7..c9e4854e2 100644 --- a/openmc/tallies.py +++ b/openmc/tallies.py @@ -1269,7 +1269,7 @@ class Tally(object): correspond directly to the two filters with two and four bins. Parameters - --------- + ---------- value : str A string for the type of value to return - 'mean' (default), 'std_dev', 'rel_err', 'sum', or 'sum_sq' are accepted