crp/OpenMC
1
0
Fork 0
mirror of https://github.com/openmc-dev/openmc.git synced 2026-07-28 14:15:42 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

Start cleaning up documentation

Browse source
This commit is contained in:
Paul Romano 2018-02-19 22:51:53 -06:00
parent a460782691
commit a9df0465f0
21 changed files with 131 additions and 142 deletions
Download patch file Download diff file Expand all files Collapse all files

62
docs/source/pythonapi/deplete.rst Normal file
View file

@ -0,0 +1,62 @@
.. _pythonapi_deplete:
----------------------------------
:mod:`openmc.deplete` -- Depletion
----------------------------------
Integrators
-----------
.. autosummary::
:toctree: generated
:nosignatures:
:template: myfunction.rst
openmc.deplete.integrator.predictor
openmc.deplete.integrator.cecm
Integrator Helper Functions
---------------------------
.. autosummary::
:toctree: generated
:nosignatures:
:template: myfunction.rst
openmc.deplete.integrator.CRAM16
openmc.deplete.integrator.CRAM48
openmc.deplete.integrator.save_results
Metaclasses
-----------
.. autosummary::
:toctree: generated
:nosignatures:
:template: myclass.rst
openmc.deplete.TransportOperator
OpenMC Classes
--------------
.. autosummary::
:toctree: generated
:nosignatures:
:template: myclass.rst
openmc.deplete.Operator
openmc.deplete.OperatorResult
Data Classes
------------
.. autosummary::
:toctree: generated
:nosignatures:
:template: myclass.rst
openmc.deplete.AtomNumber
openmc.deplete.Chain
openmc.deplete.Nuclide
openmc.deplete.ReactionRates
openmc.deplete.Results