crp/OpenMC
1
0
Fork 0
mirror of https://github.com/openmc-dev/openmc.git synced 2026-07-28 22:26:08 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

updated documentation

Browse source
This commit is contained in:
Bryan Herman 2014-04-11 09:10:25 -04:00
parent 5a89348898
commit c929ccc421
3 changed files with 30 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

10
docs/source/devguide/workflow.rst
View file

@ -108,6 +108,15 @@ before submitting a formal pull request using gfortran and intel compilers
if available.
The test suite is designed to integrate with cmake using ctest_.
It is configured to run with cross sections from NNDC_. To
download these cross sections please do the following:
.. code-block:: sh
cd ../data
python get_nndc.py
export CROSS_SECTIONS=<path_to_data_folder>/nndc/cross_sections.xml
The test suite can be run on an already existing build using:
.. code-block:: sh
@ -233,3 +242,4 @@ from your private repository into a public fork.
.. _paid plan: https://github.com/plans
.. _Bitbucket: https://bitbucket.org
.. _ctest: http://www.cmake.org/cmake/help/v2.8.12/ctest.html
.. _NNDC: http://http://www.nndc.bnl.gov/endf/b7.1/acefiles.html

8
docs/source/usersguide/install.rst
View file

@ -325,7 +325,9 @@ This will build an executable named ``openmc``.
Testing Build
-------------
If you have ENDF/B-VII.0 cross sections from MCNP5/X you can test your build.
If you have ENDF/B-VII.1 cross sections from NNDC_ you can test your build.
Make sure the **CROSS_SECTIONS** environmental variable is set to the
*cross_sections.xml* file in the *data/nndc* directory.
There are two ways to run tests. The first is to use the Makefile present in
the source directory and run the following:
@ -370,7 +372,8 @@ extract, and set up a confiuration file:
python get_nndc_data.py
At this point, you should set the :envvar:`CROSS_SECTIONS` environment variable
to the absolute path of the file ``openmc/data/nndc/cross_sections.xml``.
to the absolute path of the file ``openmc/data/nndc/cross_sections.xml``. This
cross section set is used by the test suite.
Using JEFF Cross Sections from OECD/NEA
---------------------------------------
@ -491,3 +494,4 @@ schemas.xml file in your own OpenMC source directory.
.. _validation: http://en.wikipedia.org/wiki/XML_validation
.. _RELAX NG: http://relaxng.org/
.. _ctest: http://www.cmake.org/cmake/help/v2.8.12/ctest.html
.. _NNDC: http://http://www.nndc.bnl.gov/endf/b7.1/acefiles.html

14
tests/readme.rst
View file

@ -18,6 +18,19 @@ full test suite run:
python run_tests.py
The test suite is configured to run with cross sections from NNDC_. To
download these cross sections please do the following:
.. code-block:: sh
cd ../data
python get_nndc.py
export CROSS_SECTIONS=<path_to_data_folder>/nndc/cross_sections.xml
The environmental variable **CROSS_SECTIONS** can be used to quickly switch
between the cross sections set for the test suite and cross section set for
your simulations.
A subset of build configurations and/or tests can be run. To see how to use
the script run:
@ -42,3 +55,4 @@ can run:
python run_tests.py -p
.. _ctest: http://www.cmake.org/cmake/help/v2.8.12/ctest.html
.. _NNDC: http://http://www.nndc.bnl.gov/endf/b7.1/acefiles.html