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

Remove xs conversion scripts and update documentation

Browse source
This commit is contained in:
Paul Romano 2019-02-12 17:14:52 -06:00
parent cf65d9ed2e
commit 90568ba96c
10 changed files with 60 additions and 905 deletions
Download patch file Download diff file Expand all files Collapse all files

107
docs/source/usersguide/scripts.rst
View file

@ -95,94 +95,6 @@ otherwise.
--fission_energy_release FISSION_ENERGY_RELEASE
HDF5 file containing fission energy release data
.. _scripts_mcnp70:
------------------------------
``openmc-convert-mcnp70-data``
------------------------------
This script converts ENDF/B-VII.0 ACE data from the MCNP5/6 distribution into an
HDF5 library that can be used by OpenMC. This assumes that you have a directory
containing files named endf70a, endf70b, ..., endf70k, and endf70sab. The path
to the directory containing these files should be given as a positional
argument. The following optional arguments are available:
-d DESTINATION, --destination DESTINATION
Directory to create new library in (Default: mcnp_endfb70)
.. _scripts_mcnp71:
------------------------------
``openmc-convert-mcnp71-data``
------------------------------
This script converts ENDF/B-VII.1 ACE data from the MCNP6 distribution into an
HDF5 library that can be used by OpenMC. This assumes that you have a directory
containing subdirectories 'endf71x' and 'ENDF71SaB'. The path to the directory
containing these subdirectories should be given as a positional argument. The
following optional arguments are available:
-d DESTINATION, --destination DESTINATION
Directory to create new library in (Default: mcnp_endfb71)
-f FER, --fission_energy_release FER
HDF5 file containing fission energy release data
.. _scripts_jeff:
------------------------
``openmc-get-jeff-data``
------------------------
This script downloads `JEFF 3.2 ACE data
<https://www.oecd-nea.org/dbforms/data/eva/evatapes/jeff_32/>`_ from OECD/NEA
and converts it to a multi-temperature HDF5 library for use with OpenMC. It has
the following optional arguments:
-b, --batch
Suppress standard in
-d DESTINATION, --destination DESTINATION
Directory to create new library in (default: jeff-3.2-hdf5)
.. warning:: This script will download approximately 9 GB of data. Extracting
and processing the data may require as much as 40 GB of additional
free disk space.
.. _scripts_nndc:
------------------------
``openmc-get-nndc-data``
------------------------
This script downloads `ENDF/B-VII.1
<http://www.nndc.bnl.gov/endf/b7.1/acefiles.html>`_ incident neutron ACE data
and incident photon ENDF data from NNDC and converts it to an HDF5 library for
use with OpenMC. This script has the following optional arguments:
-b, --batch
Suppress standard in
-n, --neutron_only
Whether to exclude photon interaction/atomic data
.. _scripts_photon:
--------------------------
``openmc-get-photon-data``
--------------------------
This script downloads `ENDF data <http://www.nndc.bnl.gov/endf/b7.1/zips/>`_
from NNDC for photo-atomic and atomic relaxation sublibraries and converts it
to an HDF5 library for use with photon transport in OpenMC. This script has the
following optional arguments:
-b, --batch
Suppress standard in
-c, --cross-sections
cross_sections.xml file to append libraries to
.. _scripts_compton:
-----------------------
@ -294,24 +206,21 @@ Message Description
.. _scripts_voxel:
---------------------------
``openmc-voxel-to-silovtk``
``openmc-voxel-to-vtk``
---------------------------
When OpenMC generates :ref:`voxel plots <usersguide_voxel>`, they are in an
:ref:`HDF5 format <io_voxel>` that is not terribly useful by itself. The
``openmc-voxel-to-silovtk`` script converts a voxel HDF5 file to `VTK
<http://www.vtk.org/>`_ or `SILO
<https://wci.llnl.gov/simulation/computer-codes/silo>`_ file. For VTK, you need
to have the VTK Python bindings installed. For SILO, you need to have `silomesh
<https://github.com/nhorelik/silomesh>`_ installed. To convert a voxel file,
simply provide the path to the file:
``openmc-voxel-to-vtk`` script converts a voxel HDF5 file to a `VTK
<http://www.vtk.org/>`_ file. To run this script, you will need to have the VTK
Python bindings installed. To convert a voxel file, simply provide the path to
the file:
.. code-block:: sh
openmc-voxel-to-silovtk voxel_1.h5
openmc-voxel-to-vtk voxel_1.h5
The ``openmc-voxel-to-silovtk`` script also takes the following optional
The ``openmc-voxel-to-vtk`` script also takes the following optional
command-line arguments:
-o, --output Path to output VTK or SILO file
-s, --silo Flag to convert to SILO instead of VTK
-o, --output Path to output VTK file