Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc additions, docstring typo fixes, cross section processing scripts #90

Merged
merged 37 commits into from
Dec 17, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
37 commits
Select commit Hold shift + click to select a range
5b4a0a6
Added section on cross sections and testing
yardasol Dec 10, 2021
d3c24c8
fix code blocks
yardasol Dec 10, 2021
07605f9
Clean up some depcode docstrings
yardasol Dec 10, 2021
c165a96
typo fixes
yardasol Dec 10, 2021
8e39b76
comment out section on recommended cross sections
yardasol Dec 10, 2021
d4b7345
added scripts for downloading and processing the JEFF 3.1.2 library f…
yardasol Dec 12, 2021
356eff0
pep8 fixes
yardasol Dec 12, 2021
f05c2b4
add line to allow users to specify where libary gets downloaded
yardasol Dec 12, 2021
a1eb1bf
bug fix
yardasol Dec 12, 2021
e1ffbb5
added blurb about the xsdata scripts
yardasol Dec 12, 2021
843c027
adjust formatting, add cleanup line, remove intermediate .dir files
yardasol Dec 12, 2021
96da230
clean up formatting, fix links
yardasol Dec 12, 2021
e59855e
pep8 fixes
yardasol Dec 12, 2021
e6761f2
change all references to Serpent to Serpent2
yardasol Dec 12, 2021
0d9367c
Added lines to convert from DOS to unix file format
yardasol Dec 13, 2021
2f33abe
started README.md
yardasol Dec 13, 2021
66415f2
added reference to README under scripts
yardasol Dec 13, 2021
67d4bf1
style changes
yardasol Dec 13, 2021
4c792b9
combine donwload and process scripts into one
yardasol Dec 13, 2021
d987c74
Added code block for running the script
yardasol Dec 13, 2021
85f67b1
update change_sim_par docs
yardasol Dec 13, 2021
5ea3bda
Update Depcode docstring
yardasol Dec 13, 2021
bc548b4
update write_depcode_input docstrings
yardasol Dec 13, 2021
71d3f5f
update write_mat_file docstrings
yardasol Dec 13, 2021
7393cbb
update docstrings for create_iter_matfile
yardasol Dec 13, 2021
9a5bb5f
update the rest of hte docstrings
yardasol Dec 13, 2021
effcacc
pep8 fixes
yardasol Dec 13, 2021
dd19f98
finish intro sentence
yardasol Dec 13, 2021
0aa8962
change maintainer to Oleksandr Yardas
yardasol Dec 15, 2021
307f976
update software version
yardasol Dec 15, 2021
02c20aa
fix extra indent
yardasol Dec 15, 2021
e64ee21
template_fname->template_path, input_fname->input_path
yardasol Dec 16, 2021
14c5a30
fix merge conflict
yardasol Dec 16, 2021
c9ab1f5
typo fix
yardasol Dec 16, 2021
c91df5b
Added some sentences on temperature selection for JEFF3.1.2 library f…
yardasol Dec 16, 2021
75bd409
Added more temps, sfy and nfy files
yardasol Dec 16, 2021
1563ef1
add mention of the sfy and nfy data
yardasol Dec 16, 2021
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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