OpenMC/docs/source/pythonapi
Andrew Johnson 72471d249f
Expand openmc.deplete documentation: minimal example and ABCs
Slight reformatting of the depletion documentation. The "Primary API"
is presented at the top, including integrators and the Operator.
This section is followed by a "Minimal Example" that demonstrates
how one might instantiate an Operator, and use it for depletion.
The comm communicator is moved into the "Internal Classes and Functions"
section, as the end-user is less likely to interact with this directly.
Lastly, a section on "Abstract Base Classes" is provided and expanded,
documenting the purpose of specific ABCs.
2019-09-17 14:56:31 -05:00
..
base.rst Change Python Mesh class to RegularMesh 2019-06-07 08:51:09 -04:00
capi.rst Rename openmc.capi -> openmc.lib 2019-09-13 10:38:26 -05:00
data.rst Respond to @nelsonag comments on #1271 2019-07-01 07:09:10 -05:00
deplete.rst Expand openmc.deplete documentation: minimal example and ABCs 2019-09-17 14:56:31 -05:00
examples.rst Respond to @wbinventor comments on #852 2017-04-10 07:16:17 -05:00
index.rst Improve display of Python API in generated HTML documentation 2019-06-14 14:35:39 -05:00
mgxs.rst Get GROUP_STRUCTURES to show up in documentation 2018-11-07 07:36:08 -06:00
model.rst Add opemc.model.pin to python api documentation 2019-07-09 20:25:34 -05:00
openmoc.rst Respond to comments on #850 2017-04-05 11:13:21 -05:00
stats.rst Missing one review comment, and followed style for generic normal distribution from uniform distribuion 2018-12-13 15:37:47 +00:00