Skip to content

Commit aeb5f1d

Browse files
committed
unified the intro text for the package on github and readthedocs
1 parent de71686 commit aeb5f1d

File tree

4 files changed

+50
-28
lines changed

4 files changed

+50
-28
lines changed

README.md

Lines changed: 20 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -20,33 +20,26 @@
2020

2121
# OpenMC DAGMC Wrapper
2222

23-
The openmc-dagmc-wrapper python package allows convenient access to a series of standard neutronics simulations and post using OpenMC and DAGMC.
24-
25-
The intended use case is to take DAGMC compatible h5m files generated by
26-
[cad_to_h5m](https://github.com/fusion-energy/cad_to_h5m) with CAD file inputs
27-
from the [Paramak](https://github.com/fusion-energy/paramak) as demonstrated in
28-
the [neutronics_workflow](https://github.com/fusion-energy/neutronics_workflow). However the package can also be used with h5m files generated in other ways.
29-
30-
Standard simulations tallies are facilitated:
31-
- Volume / cell tallies
32-
- Regular 2D mesh tallies
33-
- Regular 3D mesh tallies
34-
- Unstructured mesh tally (on road map)
35-
36-
Neutronics responses can be obtained:
37-
- Tritium Breeding Ratio (TBR)
38-
- Heating (photon and neutron)
39-
- Effective dose (photon and neutron)
40-
- Any supported reaction from the [standard OpenMC reactions](https://docs.openmc.org/en/latest/usersguide/tallies.html#scores)
41-
42-
A standard collection of materials are available by making use of the
43-
[neutronics_material_maker](https://github.com/fusion-energy/neutronics_material_maker) package.
44-
45-
OpenMC sources definitions are used for the particle sources.
46-
47-
Post processing of the OpenMC output files are also carried out to automatically
48-
provide: JSON text files, PNG images, VTK files for convenient access to the
49-
results.
23+
24+
The openmc-dagmc-wrapper python package extends OpenMC base classes and adds
25+
convenience features aimed as easing the use of OpenMC with DAGMC for
26+
fixed-source simulations.
27+
28+
The openmc-dagmc-wrapper is built around the assumption that a DAGMC geometry
29+
in the form of a h5m is used as the simulation geometry. This allows several
30+
aspects of openmc simulations to be simplified and automated.
31+
32+
Additional convenience is available when making tallies as standard tally types
33+
are added which automated the application of openmc.Filters and openmc.scores
34+
for standard tallies such as neutron spectra, effective dose, heating, TBR and
35+
others.
36+
37+
Further simplifications are access by using additional packages from the
38+
[fusion-neutronics-workflow](https://github.com/fusion-energy/fusion_neutronics_workflow)
39+
40+
If you are looking for an easy neutronics interface for performing simulations
41+
of fusion reactors this package was built for you.
42+
5043

5144
:point_right: [Documentation](https://openmc-dagmc-wrapper.readthedocs.io)
5245

docs/source/index.rst

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,12 @@ fixed-source simulations.
77

88
The openmc-dagmc-wrapper is built around the assumption that a DAGMC geometry
99
in the form of a h5m is used as the simulation geometry. This allows several
10-
aspects of openmc simulations to be simplified.
10+
aspects of openmc simulations to be simplified and automated.
11+
12+
Additional convenience is available when making tallies as standard tally types
13+
are added which automated the application of openmc.Filters and openmc.scores
14+
for standard tallies such as neutron spectra, effective dose, heating, TBR and
15+
others.
1116

1217
Further simplifications are access by using additional packages from the
1318
`fusion-neutronics-workflow <https://github.com/fusion-energy/fusion_neutronics_workflow>`_

docs/source/materials.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
11

2+
A standard collection of materials are available by making use of the
3+
[neutronics_material_maker](https://github.com/fusion-energy/neutronics_material_maker) package.
4+
25
Materials()
36
-----------
47

docs/source/tally.rst

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,27 @@
22
tally
33
=====
44

5+
Standard simulations tallies are facilitated:
6+
- Volume / cell tallies
7+
- Regular 2D mesh tallies
8+
- Regular 3D mesh tallies
9+
- Unstructured mesh tally
10+
11+
Neutronics responses can be obtained:
12+
- Tritium Breeding Ratio (TBR)
13+
- Heating (photon and neutron)
14+
- Effective dose (photon and neutron)
15+
- Spectrum (photon and neutron)
16+
- Damage per Atom (DPA)
17+
- Any supported reaction from the [standard OpenMC reactions](https://docs.openmc.org/en/latest/usersguide/tallies.html#scores)
18+
19+
Additionally the ability to target the tally to material tags or volume ids
20+
that exist in the DAGMC h5m file offer easy access to tallies.
21+
22+
Bounding boxes for the tallies can be automatically found and extended using
23+
the `dagmc-bounding-box <https://github.com/fusion-energy/dagmc_bounding_box>`_
24+
package.
25+
526

627
MeshTally2D()
728
-------------

0 commit comments

Comments
 (0)