mirror of
https://github.com/openmc-dev/openmc.git
synced 2026-07-22 06:55:35 -04:00
302 lines
5.9 KiB
ReStructuredText
302 lines
5.9 KiB
ReStructuredText
.. _pythonapi:
|
|
|
|
==========
|
|
Python API
|
|
==========
|
|
|
|
OpenMC includes a rich Python API that enables programmatic pre- and
|
|
post-processing. The easiest way to begin using the API is to take a look at the
|
|
example Jupyter_ notebooks provided. However, this assumes that you are already
|
|
familiar with Python and common third-party packages such as NumPy_. If you have
|
|
never programmed in Python before, there are many good tutorials available
|
|
online. We recommend going through the modules from Codecademy_ and/or the
|
|
`Scipy lectures`_. The full API documentation serves to provide more information
|
|
on a given module or class.
|
|
|
|
-------------------------
|
|
Example Jupyter Notebooks
|
|
-------------------------
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
examples/post-processing
|
|
examples/pandas-dataframes
|
|
examples/tally-arithmetic
|
|
examples/mgxs-part-i
|
|
examples/mgxs-part-ii
|
|
examples/mgxs-part-iii
|
|
examples/mgxs-part-iv
|
|
|
|
------------------------------------
|
|
:mod:`openmc` -- Basic Functionality
|
|
------------------------------------
|
|
|
|
Handling nuclear data
|
|
---------------------
|
|
|
|
Classes
|
|
+++++++
|
|
|
|
.. autosummary::
|
|
:toctree: generated
|
|
:nosignatures:
|
|
:template: myclass.rst
|
|
|
|
openmc.XSdata
|
|
openmc.MGXSLibrary
|
|
|
|
Functions
|
|
+++++++++
|
|
|
|
.. autosummary::
|
|
:toctree: generated
|
|
:nosignatures:
|
|
|
|
openmc.ace.ascii_to_binary
|
|
|
|
Simulation Settings
|
|
-------------------
|
|
|
|
.. autosummary::
|
|
:toctree: generated
|
|
:nosignatures:
|
|
:template: myclass.rst
|
|
|
|
openmc.Source
|
|
openmc.ResonanceScattering
|
|
openmc.Settings
|
|
|
|
Material Specification
|
|
----------------------
|
|
|
|
.. autosummary::
|
|
:toctree: generated
|
|
:nosignatures:
|
|
:template: myclass.rst
|
|
|
|
openmc.Nuclide
|
|
openmc.Element
|
|
openmc.Macroscopic
|
|
openmc.Material
|
|
openmc.Materials
|
|
|
|
Building geometry
|
|
-----------------
|
|
|
|
.. autosummary::
|
|
:toctree: generated
|
|
:nosignatures:
|
|
:template: myclass.rst
|
|
|
|
openmc.Plane
|
|
openmc.XPlane
|
|
openmc.YPlane
|
|
openmc.ZPlane
|
|
openmc.XCylinder
|
|
openmc.YCylinder
|
|
openmc.ZCylinder
|
|
openmc.Sphere
|
|
openmc.Cone
|
|
openmc.XCone
|
|
openmc.YCone
|
|
openmc.ZCone
|
|
openmc.Quadric
|
|
openmc.Halfspace
|
|
openmc.Intersection
|
|
openmc.Union
|
|
openmc.Complement
|
|
openmc.Cell
|
|
openmc.Universe
|
|
openmc.RectLattice
|
|
openmc.HexLattice
|
|
openmc.Geometry
|
|
|
|
Many of the above classes are derived from several abstract classes:
|
|
|
|
.. autosummary::
|
|
:toctree: generated
|
|
:nosignatures:
|
|
:template: myclass.rst
|
|
|
|
openmc.Surface
|
|
openmc.Region
|
|
openmc.Lattice
|
|
|
|
One function is also available to create a hexagonal region defined by the
|
|
intersection of six surface half-spaces.
|
|
|
|
.. autosummary::
|
|
:toctree: generated
|
|
:nosignatures:
|
|
:template: myfunction.rst
|
|
|
|
openmc.make_hexagon_region
|
|
|
|
Constructing Tallies
|
|
--------------------
|
|
|
|
.. autosummary::
|
|
:toctree: generated
|
|
:nosignatures:
|
|
:template: myclass.rst
|
|
|
|
openmc.Filter
|
|
openmc.Mesh
|
|
openmc.Trigger
|
|
openmc.Tally
|
|
openmc.Tallies
|
|
|
|
Coarse Mesh Finite Difference Acceleration
|
|
------------------------------------------
|
|
|
|
.. autosummary::
|
|
:toctree: generated
|
|
:nosignatures:
|
|
:template: myclass.rst
|
|
|
|
openmc.CMFDMesh
|
|
openmc.CMFD
|
|
|
|
Plotting
|
|
--------
|
|
|
|
.. autosummary::
|
|
:toctree: generated
|
|
:nosignatures:
|
|
:template: myclass.rst
|
|
|
|
openmc.Plot
|
|
openmc.Plots
|
|
|
|
Running OpenMC
|
|
--------------
|
|
|
|
.. autosummary::
|
|
:toctree: generated
|
|
:nosignatures:
|
|
:template: myfunction.rst
|
|
|
|
openmc.run
|
|
openmc.plot_geometry
|
|
|
|
Post-processing
|
|
---------------
|
|
|
|
.. autosummary::
|
|
:toctree: generated
|
|
:nosignatures:
|
|
:template: myclass.rst
|
|
|
|
openmc.Particle
|
|
openmc.StatePoint
|
|
openmc.Summary
|
|
|
|
Various classes may be created when performing tally slicing and/or arithmetic:
|
|
|
|
.. autosummary::
|
|
:toctree: generated
|
|
:nosignatures:
|
|
:template: myclass.rst
|
|
|
|
openmc.arithmetic.CrossScore
|
|
openmc.arithmetic.CrossNuclide
|
|
openmc.arithmetic.CrossFilter
|
|
openmc.arithmetic.AggregateScore
|
|
openmc.arithmetic.AggregateNuclide
|
|
openmc.arithmetic.AggregateFilter
|
|
|
|
---------------------------------
|
|
:mod:`openmc.stats` -- Statistics
|
|
---------------------------------
|
|
|
|
Univariate Probability Distributions
|
|
------------------------------------
|
|
|
|
.. autosummary::
|
|
:toctree: generated
|
|
:nosignatures:
|
|
:template: myclass.rst
|
|
|
|
openmc.stats.Univariate
|
|
openmc.stats.Discrete
|
|
openmc.stats.Uniform
|
|
openmc.stats.Maxwell
|
|
openmc.stats.Watt
|
|
openmc.stats.Tabular
|
|
|
|
Angular Distributions
|
|
---------------------
|
|
|
|
.. autosummary::
|
|
:toctree: generated
|
|
:nosignatures:
|
|
:template: myclass.rst
|
|
|
|
openmc.stats.UnitSphere
|
|
openmc.stats.PolarAzimuthal
|
|
openmc.stats.Isotropic
|
|
openmc.stats.Monodirectional
|
|
|
|
Spatial Distributions
|
|
---------------------
|
|
|
|
.. autosummary::
|
|
:toctree: generated
|
|
:nosignatures:
|
|
:template: myclass.rst
|
|
|
|
openmc.stats.Spatial
|
|
openmc.stats.CartesianIndependent
|
|
openmc.stats.Box
|
|
openmc.stats.Point
|
|
|
|
----------------------------------------------------------
|
|
:mod:`openmc.mgxs` -- Multi-Group Cross Section Generation
|
|
----------------------------------------------------------
|
|
|
|
Energy Groups
|
|
-------------
|
|
|
|
.. autosummary::
|
|
:toctree: generated
|
|
:nosignatures:
|
|
:template: myclass.rst
|
|
|
|
openmc.mgxs.EnergyGroups
|
|
|
|
Multi-group Cross Sections
|
|
--------------------------
|
|
|
|
.. autosummary::
|
|
:toctree: generated
|
|
:nosignatures:
|
|
:template: myclass.rst
|
|
|
|
openmc.mgxs.MGXS
|
|
openmc.mgxs.AbsorptionXS
|
|
openmc.mgxs.CaptureXS
|
|
openmc.mgxs.Chi
|
|
openmc.mgxs.FissionXS
|
|
openmc.mgxs.NuFissionXS
|
|
openmc.mgxs.NuScatterXS
|
|
openmc.mgxs.NuScatterMatrixXS
|
|
openmc.mgxs.ScatterXS
|
|
openmc.mgxs.ScatterMatrixXS
|
|
openmc.mgxs.TotalXS
|
|
openmc.mgxs.TransportXS
|
|
|
|
Multi-group Cross Section Libraries
|
|
-----------------------------------
|
|
|
|
.. autosummary::
|
|
:toctree: generated
|
|
:nosignatures:
|
|
:template: myclass.rst
|
|
|
|
openmc.mgxs.Library
|
|
|
|
.. _Jupyter: https://jupyter.org/
|
|
.. _NumPy: http://www.numpy.org/
|
|
.. _Codecademy: https://www.codecademy.com/tracks/python
|
|
.. _Scipy lectures: https://scipy-lectures.github.io/
|