https://github.com/fusion-energy/openmc_regular_mesh_plotter

A Python package for plotting OpenMC regular mesh tally results with underlying geometry from neutronics simulations.
https://github.com/fusion-energy/openmc_regular_mesh_plotter

dose map mesh neutronics plot regular structured tally

Last synced: 3 months ago
JSON representation

A Python package for plotting OpenMC regular mesh tally results with underlying geometry from neutronics simulations.

• Host: GitHub
• URL: https://github.com/fusion-energy/openmc_regular_mesh_plotter
• Owner: fusion-energy
• License: mit
• Created: 2021-10-14T11:19:46.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2025-05-06T13:04:25.000Z (12 months ago)
• Last Synced: 2025-09-24T22:56:23.563Z (7 months ago)
• Topics: dose, map, mesh, neutronics, plot, regular, structured, tally
• Language: Python
• Homepage:
• Size: 183 KB
• Stars: 13
• Watchers: 1
• Forks: 1
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt
  • Citation: CITATION.cff

Awesome Lists containing this project

README

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

[![CI with install](https://github.com/fusion-energy/openmc_regular_mesh_plotter/actions/workflows/ci_with_install.yml/badge.svg)](https://github.com/fusion-energy/openmc_regular_mesh_plotter/actions/workflows/ci_with_install.yml)

[![PyPI](https://img.shields.io/pypi/v/openmc-regular-mesh-plotter?color=brightgreen&label=pypi&logo=grebrightgreenen&logoColor=green)](https://pypi.org/project/openmc-regular-mesh-plotter/)

# A minimal Python package that plots slices of OpenMC regular mesh tallies with the model geometry.

Features

:straight_ruler: Axis units in in helpful units mm, cm, m, km

:eyes: Supports all 3 viewing basis (xy, xz, yz)

:hocho: Automaticly finds central slice or allows user specified slice index

:dart: Supports all values (mean, std_dev etc)

:black_square_button: Adds outlines for geometry cells or material at different pixel resolution

:arrow_right_hook: Customisable by passing keywords to underlying matplotlib functions colorbar, contour and imshow

:arrow_right_hook: supports further customisations throught ```matplotlib.rc()```

:heavy_plus_sign: Add tally results together to get combined plot.

|||

# Local install

First you will need openmc installed, then you can install this package with pip

```bash

pip install openmc_regular_mesh_plotter

```

# Usage

See the [examples folder](https://github.com/fusion-energy/openmc_regular_mesh_plotter/tree/main/examples) for example scripts

# Web App

This package is deployed on [xsplot.com](https://www.xsplot.com) as part of the ```openmc_plot``` suite of plotting apps