README.md

A Python app for plotting OpenMC.

This repository contains the source code for the OpenMC plot.

Try the web app at http://openmc-plot.xsplot.com

This repository contains:

• A Python Streamlit based GUI 🐍
• A Dockerfile that provides the hosting environment for the web app 🐳

Plot geometry

Plot sources

Plot regular mesh tallies

Plot weight windows

Plot cylindrical mesh tallies

Install

First you will need to install OpenMC

OpenMC_plot can then be install directly from the Python package index (PyPi) using pip.

pip install openmc_plot

Usage

In the terminal type ...

openmc_plot

Your default web browser should then load with the GUI.

You will also need to have OpenMC installed.

Run web app locally (developers)

To host your own local version of xsplot.com you will need Docker installed and then can build and run the Dockerfile with the following commands.

First clone the repository

git clone https://github.com/fusion-energy/openmc_plot

Then navigate into the repository folder

cd openmc_plot

Then build the docker image

docker build -t openmc_plot .

Then run the docker image

docker run --network host -t openmc_plot

The URL of your locally hosted version should appear in the terminal, copy and paste this URL into a web browser address bar.

Maintenance (developers)

Pushing to the main branch of this repository triggers an automatic rebuild and deployment of the new code using Google Cloud build at xsplot.com