Metadata-Version: 2.1
Name: openmc_cylindrical_mesh_plotter
Version: 0.1.2
Summary: A Python package for creating publication quality plots of cylindrical mesh tallies
Author-email: Jonathan Shimwell <mail@jshimwell.com>
Project-URL: Homepage, https://github.com/fusion-energy/openmc_cylindrical_mesh_plotter
Project-URL: Bug Tracker, https://github.com/fusion-energy/openmc_cylindrical_mesh_plotter/issues
Keywords: cylindrical,mesh,openmc,tally,plot,slice
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8
Description-Content-Type: text/markdown
Provides-Extra: tests

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

# openmc_cylindrical_mesh_plotter

Plots R-Z or Phi-R slices of OpenMC cylindrical mesh tallies


![openmc cylinder PhiR mesh tally plot](https://user-images.githubusercontent.com/8583900/227660135-8ac2eb69-829c-4788-ae02-f9e4b1465aa6.png)
![openmc cylinder RZ mesh tally plot](https://user-images.githubusercontent.com/8583900/227660142-99bcb264-57f8-47d6-b9ff-d211645fe185.png)



## Installation

openmc_cylindrical_mesh_plotter is available on PyPi

```bash
pip install openmc_cylindrical_mesh_plotter
```

## API Usage

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

## Graphical User Interface Usage

Once installed you should be able to type the following command from the terminal and the GUI will launch in a browser window.

```bash
openmc_cylindrical_mesh_plotter
```

![openmc cylinder mesh plot GUI](https://user-images.githubusercontent.com/8583900/228016577-d5d9f541-1b4d-4d9b-a207-f3f1d08e27a8.gif)
