crp/OpenMC
1
0
Fork 0
mirror of https://github.com/openmc-dev/openmc.git synced 2026-07-27 05:35:49 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge pull request #10 from paulromano/mgxs-energy-groups

Browse source 
Get GROUP_STRUCTURES to show up in documentation
This commit is contained in:
Will Boyd 2018-11-07 09:10:32 -05:00 • committed by GitHub
commit 72e2af4c61
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 13 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

7
docs/source/_templates/mymodulevar.rst
View file

@ -1,7 +0,0 @@
{{ fullname }}
{{ underline }}
.. currentmodule:: {{ module }}
.. automodule:: {{ objname }}
:members:

12
docs/source/pythonapi/mgxs.rst
View file

@ -5,13 +5,21 @@
Energy Groups
-------------
Module Variables
++++++++++++++++
.. autodata:: openmc.mgxs.GROUP_STRUCTURES
:annotation:
Classes
+++++++
.. autosummary::
:toctree: generated
:nosignatures:
:template: myclass.rst mymodulevar.rst
:template: myclass.rst
openmc.mgxs.EnergyGroups
openmc.mgxs.GROUP_STRUCTURES
Multi-group Cross Sections
--------------------------

7
openmc/mgxs/__init__.py
View file

@ -5,11 +5,10 @@ from openmc.mgxs.mgxs import *
from openmc.mgxs.mdgxs import *
GROUP_STRUCTURES = {}
"""Commonly used energy group structures, including "CASMO-X" (where X
is 2, 4, 8, 16, 25, 40 or 70) from the [CASMO]_ lattice physics code.
"""Dictionary of commonly used energy group structures, including "CASMO-X" (where X
is 2, 4, 8, 16, 25, 40 or 70) from the CASMO_ lattice physics code.
.. [CASMO] J. Rhodes, K. Smith, and D. Lee, "CASMO-5 Development and
Applications", *Proc. ANS Topical Meeting on Reactor Physics* (2006).
.. _CASMO: https://www.studsvik.com/SharepointFiles/CASMO-5%20Development%20and%20Applications.pdf
"""