From f1ea8cfaaa6f694b5e829e1aeb98393166a694e9 Mon Sep 17 00:00:00 2001 From: Paul Romano Date: Thu, 6 Oct 2016 17:18:14 -0500 Subject: [PATCH] Move scripts in data/ folder to scripts/ --- data/readme.rst | 37 ------------------- docs/source/usersguide/install.rst | 34 +++++++---------- .../openmc-convert-mcnp70-data | 0 .../openmc-convert-mcnp71-data | 0 .../openmc-get-jeff-data | 0 .../openmc-get-multipole-data | 0 .../openmc-get-nndc-data | 0 7 files changed, 14 insertions(+), 57 deletions(-) delete mode 100644 data/readme.rst rename data/convert_mcnp_70.py => scripts/openmc-convert-mcnp70-data (100%) rename data/convert_mcnp_71.py => scripts/openmc-convert-mcnp71-data (100%) rename data/get_jeff_data.py => scripts/openmc-get-jeff-data (100%) rename data/get_multipole_data.py => scripts/openmc-get-multipole-data (100%) rename data/get_nndc_data.py => scripts/openmc-get-nndc-data (100%) diff --git a/data/readme.rst b/data/readme.rst deleted file mode 100644 index 03685491d..000000000 --- a/data/readme.rst +++ /dev/null @@ -1,37 +0,0 @@ -======================== -cross_sections.xml Files -======================== - -As a reminder, in order to run a simulation with OpenMC, you will need cross -section data for each nuclide in your problem. OpenMC is not currently -distributed with cross section data, so you will have to obtain cross section -data by other means. The `user's guide`_ offers some helpful advice on how you -can obtain cross sections. - -When OpenMC starts up, it needs a cross_sections.xml file that tells it where to -find ACE format cross sections. The files in this directory are configured to -work with a few common cross section sources. - -- **cross_sections_ascii.xml** -- This file matches ENDF/B-VII.0 cross sections - distributed with MCNP5 / MCNP6 beta. - -- **cross_sections_nndc.xml** -- This file matches ENDF/B-VII.1 cross sections - distributed from the `NNDC website`_. - -- **cross_sections_serpent.xml** -- This file matches ENDF/B-VII.0 cross - sections distributed with Serpent 1.1.7. - -- **cross_sections.xml** - This file matches ENDF/B-VII.0 cross sections - distributed with MCNP5 / MCNP6 beta *that have been converted to binary*. - -To use any of these files, you need to follow two steps: - -1. Change the path on the ```` element in the cross_sections.xml file -to the directory containing the ACE files. - -2. Enter the absolute path of the cross_sections.xml on the ```` -element in your settings.xml, or set the CROSS_SECTIONS environment variable to -the full path of the cross_sections.xml file. - -.. _user's guide: http://mit-crpg.github.io/openmc/usersguide/install.html#cross-section-configuration -.. _NNDC website: http://www.nndc.bnl.gov/endf/b7.1/acefiles.html diff --git a/docs/source/usersguide/install.rst b/docs/source/usersguide/install.rst index 5abd48ee0..0b75bf190 100644 --- a/docs/source/usersguide/install.rst +++ b/docs/source/usersguide/install.rst @@ -439,13 +439,11 @@ extract the ACE data, fix any deficiencies, and create an HDF5 library: .. code-block:: sh - cd openmc/data - python get_nndc_data.py + openmc-get-nndc-data At this point, you should set the :envvar:`OPENMC_CROSS_SECTIONS` environment -variable to the absolute path of the file -``openmc/data/nndc_hdf5/cross_sections.xml``. This cross section set is used by -the test suite. +variable to the absolute path of the file ``nndc_hdf5/cross_sections.xml``. This +cross section set is used by the test suite. Using JEFF Cross Sections from OECD/NEA --------------------------------------- @@ -456,12 +454,10 @@ and extract the ACE data, fix any deficiencies, and create an HDF5 library. .. code-block:: sh - cd openmc/data - python get_jeff_data.py + openmc-get-jeff-data At this point, you should set the :envvar:`OPENMC_CROSS_SECTIONS` environment -variable to the absolute path of the file -``openmc/data/jeff-3.2-hdf5/cross_sections.xml``. +variable to the absolute path of the file ``jeff-3.2-hdf5/cross_sections.xml``. Using Cross Sections from MCNP ------------------------------ @@ -473,8 +469,7 @@ format, run the following: .. code-block:: sh - cd openmc/data - python convert_mcnp_endf70.py /path/to/mcnpdata/ + openmc-convert-mcnp70-data /path/to/mcnpdata/ where ``/path/to/mcnpdata`` is the directory containing the ``endf70[a-k]`` files. @@ -484,8 +479,7 @@ the following script: .. code-block:: sh - cd openmc/data - python convert_mcnp_endf71.py /path/to/mcnpdata + openmc-convert-mcnp71-data /path/to/mcnpdata where ``/path/to/mcnpdata`` is the directory containing the ``endf71x`` and ``ENDF71SaB`` directories. @@ -502,16 +496,16 @@ that are to be converted: 1. List each ACE library as a positional argument. This is very useful in conjunction with the usual shell utilities (ls, find, etc.). -2. Use the --xml option to specify a pre-v0.9 cross_sections.xml file. -3. Use the --xsdir option to specify a MCNP xsdir file. -4. Use the --xsdata option to specify a Serpent xsdata file. +2. Use the ``--xml`` option to specify a pre-v0.9 cross_sections.xml file. +3. Use the ``--xsdir` option to specify a MCNP xsdir file. +4. Use the ``--xsdata`` option to specify a Serpent xsdata file. The script does not use any extra information from cross_sections.xml/ xsdir/ xsdata files to determine whether the nuclide is metastable. Instead, the ---metastable argument can be used to specify whether the ZAID naming convention -follows the NNDC data convention (1000*Z + A + 300 + 100*m), or the MCNP data -convention (essentially the same as NNDC, except that the first metastable state -of Am242 is 95242 and the ground state is 95642). +``--metastable`` argument can be used to specify whether the ZAID naming +convention follows the NNDC data convention (1000*Z + A + 300 + 100*m), or the +MCNP data convention (essentially the same as NNDC, except that the first +metastable state of Am242 is 95242 and the ground state is 95642). The ``openmc-ace-to-hdf5`` script has the following command-line flags: diff --git a/data/convert_mcnp_70.py b/scripts/openmc-convert-mcnp70-data similarity index 100% rename from data/convert_mcnp_70.py rename to scripts/openmc-convert-mcnp70-data diff --git a/data/convert_mcnp_71.py b/scripts/openmc-convert-mcnp71-data similarity index 100% rename from data/convert_mcnp_71.py rename to scripts/openmc-convert-mcnp71-data diff --git a/data/get_jeff_data.py b/scripts/openmc-get-jeff-data similarity index 100% rename from data/get_jeff_data.py rename to scripts/openmc-get-jeff-data diff --git a/data/get_multipole_data.py b/scripts/openmc-get-multipole-data similarity index 100% rename from data/get_multipole_data.py rename to scripts/openmc-get-multipole-data diff --git a/data/get_nndc_data.py b/scripts/openmc-get-nndc-data similarity index 100% rename from data/get_nndc_data.py rename to scripts/openmc-get-nndc-data