Metadata-Version: 2.1
Name: openmc-dagmc-wrapper
Version: 0.1.2
Summary: Perform a set of standard neutronics simulations with OpenMC and DAGMC
Home-page: https://github.com/fusion-energy/openmc_dagmc_wrapper
Author: The openmc_dagmc_wrapper Development Team
Author-email: mail@jshimwell.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
Requires-Dist: remove-dagmc-tags
Requires-Dist: neutronics-material-maker
Requires-Dist: vtk
Requires-Dist: openmc-data-downloader
Requires-Dist: matplotlib
Requires-Dist: plotly
Requires-Dist: defusedxml
Requires-Dist: nbformat
Requires-Dist: nbconvert
Requires-Dist: dagmc-h5m-file-inspector


[![N|Python](https://www.python.org/static/community_logos/python-powered-w-100x40.png)](https://www.python.org)

[![CircleCI](https://circleci.com/gh/fusion-energy/openmc-dagmc-wrapper/tree/main.svg?style=svg)](https://circleci.com/gh/fusion-energy/openmc-dagmc-wrapper/tree/main)
[![CI with install](https://github.com/fusion-energy/openmc-dagmc-wrapper/actions/workflows/ci_with_install.yml/badge.svg)](https://github.com/fusion-energy/openmc-dagmc-wrapper/actions/workflows/ci_with_install.yml)
[![CI with docker build](https://github.com/fusion-energy/openmc-dagmc-wrapper/actions/workflows/ci_with_docker_build.yml/badge.svg)](https://github.com/fusion-energy/openmc-dagmc-wrapper/actions/workflows/ci_with_docker_build.yml)

[![codecov](https://codecov.io/gh/fusion-energy/openmc-dagmc-wrapper/branch/main/graph/badge.svg?token=5j7c7eGF6W)](https://codecov.io/gh/fusion-energy/openmc-dagmc-wrapper)

[![Code Grade](https://www.code-inspector.com/project/25343/score/svg)](https://frontend.code-inspector.com/public/project/25343/openmc-dagmc-wrapper/dashboard)
[![Code Grade](https://www.code-inspector.com/project/25343/status/svg)](https://frontend.code-inspector.com/public/project/25343/openmc-dagmc-wrapper/dashboard)

[![Documentation Status](https://readthedocs.org/projects/openmc-dagmc-wrapper/badge/?version=latest)](https://openmc-dagmc-wrapper.readthedocs.io/en/latest/?badge=latest)

[![Upload Python Package](https://github.com/fusion-energy/openmc-dagmc-wrapper/actions/workflows/python-publish.yml/badge.svg)](https://github.com/fusion-energy/openmc-dagmc-wrapper/actions/workflows/python-publish.yml)
[![PyPI](https://img.shields.io/pypi/v/openmc-dagmc-wrapper?color=brightgreen&label=pypi&logo=grebrightgreenen&logoColor=green)](https://pypi.org/project/openmc-dagmc-wrapper/)

[![docker-publish-release](https://github.com/fusion-energy/openmc-dagmc-wrapper/actions/workflows/docker_publish.yml/badge.svg)](https://github.com/fusion-energy/openmc-dagmc-wrapper/actions/workflows/docker_publish.yml)


# OpenMC DAGMC Wrapper

The openmc-dagmc-wrapper python package allows convenient access to a series of standard neutronics simulations and post using OpenMC and DAGMC.

The intended use case is to take DAGMC compatible h5m files generated by 
[cad_to_h5m](https://github.com/fusion-energy/cad_to_h5m) with CAD file inputs
from the [Paramak](https://github.com/fusion-energy/paramak) as demonstrated in
the [neutronics_workflow](https://github.com/fusion-energy/neutronics_workflow). However the package can also be used with h5m files generated in other ways.

Standard simulations tallies are facilitated:
- Volume / cell tallies
- Regular 2D mesh tallies
- Regular 3D mesh tallies
- Unstructured mesh tally (on road map)

Neutronics responses can be obtained:
- Tritium Breeding Ratio (TBR)
- Heating (photon and neutron)
- Dose (on road map)
- Any supported reaction from the standard OpenMC reactions

A standard collection of materials are available by making use of the
[neutronics_material_maker](https://github.com/fusion-energy/neutronics_material_maker) package.

OpenMC sources definitions are used for the particle sources. 

Post processing of results are also carried out to automatically provide images,
JSON output files and VTK files for convenient access to the results.

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

:point_right: [Docker images](https://github.com/fusion-energy/openmc_dagmc_wrapper/pkgs/container/openmc_dagmc_wrapper)

:point_right: [Installation](https://openmc-dagmc-wrapper.readthedocs.io/en/stable/install.html)

:point_right: [Examples](https://openmc-dagmc-wrapper.readthedocs.io/en/stable/example_neutronics_simulations.html)


