|
20 | 20 |
|
21 | 21 | # OpenMC DAGMC Wrapper |
22 | 22 |
|
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 | + |
50 | 43 |
|
51 | 44 | :point_right: [Documentation](https://openmc-dagmc-wrapper.readthedocs.io) |
52 | 45 |
|
|
0 commit comments