Skip to content

Commit 4784239

Browse files
committed
Address Ansh comments. And Gwen comment #2
1 parent e6a95de commit 4784239

File tree

6 files changed

+35
-462
lines changed

6 files changed

+35
-462
lines changed

doc/examples.rst

+16-1
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,19 @@ Examples
33

44
A number of examples are present in the [examples
55
directory](https://github.com/arfc/saltproc/tree/master/examples)
6-
provided with the source code.
6+
provided with the source code.
7+
8+
Transatomic Power Molten Salt Reactor example can be run with:
9+
10+
11+
.. code-block:: bash
12+
13+
cd /path/to/saltproc
14+
python saltproc -i examples/tap_main.json
15+
16+
17+
In the example above, ``path/to/saltproc`` is, of course, the path to the main
18+
saltproc directory, containing ``setup.py``. The ``tap_main.json`` is the main
19+
Saltproc input file, which contains paths to Serpent input file
20+
(``tap.serpent``), DOT-file with reprocessing scheme (``tap.dot``), and
21+
reprocessing system components detailed description (``tap_objects.json``).

doc/overview.rst

+19-14
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
Overview
22
=========
33

4-
SaltProc couples directly with the Monte Carlo neutron transport Serpent 2 and
5-
enables sophisticated, multi-component online fuel reprocessing system modeling.
6-
SaltProc is the first open-source tool for liquid-fueled MSR depletion
7-
simulation with following capabilities:
4+
SaltProc couples directly with the Monte Carlo neutron transport code Serpent 2
5+
and enables sophisticated, multi-component online fuel reprocessing system
6+
modeling. SaltProc is the first open-source tool for liquid-fueled MSR
7+
depletion simulation with the following capabilities:
88

99
- neutron poison removal with user-defined efficiency,
1010
- make-up mass loss by fresh fuel injection,
1111
- reactivity control by adjusting fuel feed rate or geometry change,
12-
- for any reactor design,
12+
- can model any reactor design,
1313
- potentially, can couple with any depletion tool (i.e., MCNP, SCALE, OpenMC).
1414

1515

@@ -28,33 +28,38 @@ Molten Salt Reactors. It performs three major functions:
2828
The code logic flow is the following:
2929

3030
1. Runs Serpent (`saltproc.depcode.run_depcode()`)
31-
2. Parses through the output `*_dep.m` file and create PyNE Material object for each burnable material.
31+
2. Parses through the output `*_dep.m` file and creates PyNE Material object
32+
for each burnable material.
3233
3. Processes Fuel (`saltproc.app.reprocessing()` and `saltproc.refill`):
3334

34-
* Passes fuel composition throughout Processes objects (reprocessing system components) to remove poisons with specific efficiency.
35-
* Add back fissile and/or fertile material to make-up loss of material.
35+
* Passes fuel composition throughout Processes objects (reprocessing system
36+
components) to remove poisons with specific efficiency.
37+
* Adds back fissile and/or fertile material to make-up loss of material.
3638

3739
4. Records data:
3840

3941
- Depleted fuel composition (`materials/fuel/before_reproc` table in HDF5)
40-
- Reprocessed fuel composition (`materials/fuel/after_reproc` table in HDF5)
41-
- Multiplication factor at the beginning and at the end of depletion step (`simulation_parameters/keff_bds`, `simulation_parameters/keff_eds`)
42-
- Effective Delayed Neutron Fraction (:math:`\beta_{eff}`) at the end of the depletion step (`simulation_parameters/beta_eff_eds`)
42+
- Reprocessed fuel composition (`materials/fuel/after_reproc` table in
43+
HDF5)
44+
- Multiplication factor at the beginning and at the end of depletion step
45+
(`simulation_parameters/keff_bds`, `simulation_parameters/keff_eds`)
46+
- Effective Delayed Neutron Fraction (:math:`\beta_{eff}`) at the end of
47+
the depletion step (`simulation_parameters/beta_eff_eds`)
4348
- Waste and feed streams from each `Process` (`materials/in_out_streams/`)
4449

45-
5. Repeat 1-4.
50+
5. Repeats 1-4.
4651

4752

4853
The Future
4954
-----------
5055

51-
Number of features will be implemented in SaltProc soon. Support of various
56+
A number of features will be implemented in SaltProc soon. Support of various
5257
depletion codes (e.g., OpenMC) will be added.
5358

5459

5560
.. warning::
5661

5762
SaltProc is a relatively new project and is still under heavy development.
58-
Although we will make a best effort to maintain compatibility with the
63+
Although we will make our best effort to maintain compatibility with the
5964
current API, inevitably the API will change in future versions as SaltProc
6065
matures.

saltproc/data/mcsfr

-50
This file was deleted.

saltproc/data/ortho.csv

-178
This file was deleted.

0 commit comments

Comments
 (0)