Skip to content

Commit

Permalink
Merge pull request #90 from yardasol/update-docs
Browse files Browse the repository at this point in the history
`doc` additions, docstring typo fixes, cross section processing scripts
  • Loading branch information
abachma2 authored Dec 17, 2021
2 parents 3c992ec + 1563ef1 commit ca9522c
Show file tree
Hide file tree
Showing 15 changed files with 305 additions and 120 deletions.
40 changes: 39 additions & 1 deletion doc/installation.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Installation
-------------
============

SaltProc has the following dependencies:

Expand Down Expand Up @@ -42,3 +42,41 @@ Then run the following commands from the directory above cloned repository:
python setup.py install --user
Please let us know if you run into trouble.

Cross Section Configuration
---------------------------
SaltProc can use any cross section library that Serpent can. See `this page on the Serpent wiki`_ for information on how to configure the libraries.

.. _this page on the Serpent wiki: https://serpent.vtt.fi/mediawiki/index.php/Installing_and_running_Serpent#Setting_up_the_data_libraries

Testing
-------
The SaltProc test suite has two types of tests: unit tests and regression tests.
The unit tests check that the individual functions and classes of the ``saltproc``
module return the correct type of variables and correct values, where applicable.
The regression tests run a full SaltProc simulation and check the final result
with a precalculated result.
The integration tests require the `JEFF 3.1.2 cross section library`_ as well
as neutron induces and spontaneous fission product yield data from JEFF 3.3.
The publicly available versions of JEFF 3.1.2 cannot be used with Serpent right
out of the box due to `Serpent's notation for isomeric states`_. The scripts in
``scripts/xsdata`` download all necessary libraries and perform all the necessary processing on them for use in Serpent 2.
We recommend using them for your convenience.
See the `README`_ for more information.

.. _Serpent's notation for isomeric states: https://serpent.vtt.fi/mediawiki/index.php/Installing_and_running_Serpent#Setting_up_the_data_libraries
.. _JEFF 3.1.2 cross section library: https://www.oecd-nea.org/dbforms/data/eva/evatapes/jeff_31/JEFF312/
.. _README: https://github.com/arfc/saltproc/blob/master/scripts/README.md

To run the tests, execute:

.. code-block:: bash
pytest saltproc/
from the root directory of SaltProc. If you just want to run the unit tests, execute

.. code-block:: bash
pytest --ignore saltproc/tests/integration_tests saltproc/
4 changes: 2 additions & 2 deletions saltproc/app.py
Original file line number Diff line number Diff line change
Expand Up @@ -390,8 +390,8 @@ def run():
# Intializing objects
serpent = DepcodeSerpent(
exec_path=exec_path,
template_fname=template_file,
input_fname=input_file,
template_path=template_file,
input_path=input_file,
iter_matfile=iter_matfile,
geo_file=geo_file,
npop=neutron_pop,
Expand Down
Loading

0 comments on commit ca9522c

Please sign in to comment.