Merge branch 'develop' into local-photon-heating

This commit is contained in:
Paul Romano 2019-09-16 11:00:33 -05:00
commit 348dd74dcc
35 changed files with 344 additions and 328 deletions

View file

@ -1,17 +1,17 @@
.. _capi:
=====
C API
=====
=========
C/C++ API
=========
The libopenmc shared library that is built when installing OpenMC exports a
number of C interoperable functions and global variables that can be used for
in-memory coupling. While it is possible to directly use the C API as documented
here for coupling, most advanced users will find it easier to work with the
Python bindings in the :py:mod:`openmc.capi` module.
in-memory coupling. While it is possible to directly use the C/C++ API as
documented here for coupling, most advanced users will find it easier to work
with the Python bindings in the :py:mod:`openmc.lib` module.
.. warning:: The C API is still experimental and may undergo substantial changes
in future releases.
.. warning:: The C/C++ API is still experimental and may undergo substantial
changes in future releases.
----------------
Type Definitions

View file

@ -1,8 +1,8 @@
--------------------------------------------------
:mod:`openmc.capi` -- Python bindings to the C API
--------------------------------------------------
------------------------------------------------------
:mod:`openmc.lib` -- Python bindings to the C/C++ API
------------------------------------------------------
.. automodule:: openmc.capi
.. automodule:: openmc.lib
Functions
---------

View file

@ -81,6 +81,8 @@ Python API Changes
:func:`openmc.model.rectangular_prism`.
- The ``get_hexagonal_prism`` function has been renamed
:func:`openmc.model.hexagonal_prism`.
- Python bindings to the C/C++ API have been move from ``openmc.capi`` to
:mod:`openmc.lib`.
---------
Bug Fixes