Data

Tools

Indexes

Applications

Experiments

Open Source Science

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

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (10.5%) to scientific vocabulary

Keywords

dose map mesh neutronics plot regular structured tally
Last synced: 4 months ago · JSON representation ·

Repository

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

Basic Info
  • Host: GitHub
  • Owner: fusion-energy
  • License: mit
  • Language: Python
  • Default Branch: main
  • Homepage:
  • Size: 183 KB
Statistics
  • Stars: 11
  • Watchers: 1
  • Forks: 1
  • Open Issues: 8
  • Releases: 20
Topics
dose map mesh neutronics plot regular structured tally
Created about 4 years ago · Last pushed 8 months ago
Metadata Files
Readme License Citation

README.md

N|Python

CI with install

PyPI

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)

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

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

:arrowrighthook: supports further customisations throught matplotlib.rc()

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

|drawing|drawing|

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 for example scripts

Web App

This package is deployed on xsplot.com as part of the openmc_plot suite of plotting apps

Owner

  • Name: Fusion Energy
  • Login: fusion-energy
  • Kind: organization

A collection of software projects related to fusion energy

Citation (CITATION.cff) 

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- family-names: "Shimwell"
  given-names: "Jonathan"
  orcid: "https://orcid.org/0000-0001-6909-0946"
- family-names: "Delaporte-Mathurin"
  given-names: "Rémi"
  orcid: "https://orcid.org/0000-0003-1064-8882"
title: "A Python package for plotting OpenMC regular mesh tally results with underlying geometry from neutronics simulations."
version: 1.0.0
date-released: 2022-09-01
url: "https://github.com/fusion-energy/openmc_regular_mesh_plotter"

GitHub Events

Total
  • Watch event: 3
  • Push event: 1
Last Year
  • Watch event: 3
  • Push event: 1

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 172 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 6
  • Total maintainers: 2
pypi.org: openmc-regular-mesh-plotter

A Python package for creating plots of OpenMC regular mesh tallies with the underlying geometry

  • Homepage: https://github.com/fusion-energy/openmc_regular_mesh_plotter
  • Documentation: https://openmc-regular-mesh-plotter.readthedocs.io/
  • License: MIT License Copyright (c) 2021 Fusion Energy Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  • Latest release: 1.2.2
    published over 1 year ago
  • Versions: 6
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 172 Last month
Rankings
Dependent packages count: 7.5%
Average: 38.6%
Dependent repos count: 69.7%
Maintainers (2)
openmcworkshop shimwell
Last synced: 5 months ago

Dependencies

.github/workflows/black.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
  • stefanzweifel/git-auto-commit-action v4 composite
.github/workflows/ci_with_install.yml actions
  • actions/checkout v2 composite
  • codecov/codecov-action v2 composite
.github/workflows/python-publish.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
pyproject.toml pypi
  • matplotlib >=3.4.2
  • numpy >=1.21.1
  • setuptools_scm *