OpenDeplete Depletion Front-End

This is a simple depletion front-end tool. It currently only supports OpenMC as the neutronics operator. Long term goals include the addition of support for other neutronics operators.

Installation

Installation is currently very complex due to the nature of the program. OpenDeplete requires the following:

• MPI (currently OpenMPI 1.10.6 and 2.1.1 are tested)
• Python 3.3 or newer
• mpi4py
• HDF5 configured with --enable-parallel --enable-fortran --enable-fortran2003 flags. 1.8.18 is tested.
• h5py compiled with the above HDF5 library.
• OpenMC compiled with the above HDF5 library with OpenMP and MPI enabled.
• Nuclear data for OpenMC, preferrably NNDC to run the test suite.

Additionally, the OpenMC python API must be installed inside of Python 3.

Then, ensure that openmc is in the path and $OPENMC_CROSS_SECTIONS is set. Once all of these components are available, the program can be tested by running the test script from the OpenDeplete root directory:

mpiexec --bind-to none --map-by ppr:<number of CPU cores>:node --oversubscribe ./test.py  --suite full

--bind-to none allows OpenMP to work efficiently and -oversubscribe allows both the python script and OpenMC to run simultaneously. It can be installed by:

python setup.py install --user

Usage

An example script is given in three parts: example_geometry.py, example_run.py, and example_plot.py. Running example_run.py (in a way similar to test.py above) will load the geometry from example_geometry.py and run a short depletion simulation, saving the result into a test folder. Running example_plot.py will then plot a few interesting results.

The depletion chain XML file can be set using either the opendeplete.OpenMCSettings.chain_file attribute or through the $OPENDEPLETE_CHAIN environment variable.

License

OpenDeplete is distributed under the MIT license.