A minimal Python package that produces slice plots through h5m DAGMC geometry files

Last update: Dec 02, 2022

Overview

A minimal Python package that produces slice plots through h5m DAGMC geometry files

Installation

pip install dagmc_geometry_slice_plotter

Python API Usage

These examples assume you have a h5m file called dagmc.h5m in the same folder that the Python script is being run from.

Create a plot of a slice through the geometry perpendicular to the Z axis and default settings elsewhere. This will slice through the the center of the geometry as plane_origin has not been specified.

from dagmc_geometry_slice_plotter import plot_slice_of_dagmc_geometry

plot = plot_slice_of_dagmc_geometry(
    dagmc_file_or_trimesh_object='dagmc.h5m',
    plane_normal=[0, 0, 1],
)

plot.show()

Create a plot of a slice through the geometry perpendicular to the Z axis, offset by 200cm and with default settings elsewhere.

from dagmc_geometry_slice_plotter import plot_slice_of_dagmc_geometry

plot = plot_slice_of_dagmc_geometry(
    dagmc_file_or_trimesh_object='dagmc.h5m',
    plane_origin=[0, 0, 200],
    plane_normal=[0, 0, 1],
)

plot.show()

Create a plot of a slice through the geometry perpendicular to the Y axis, with a rotation of 45 degrees and with default settings elsewhere. Also saves the plot with a high resolution (DPI)

from dagmc_geometry_slice_plotter import plot_slice_of_dagmc_geometry

plot = plot_slice_of_dagmc_geometry(
    dagmc_file_or_trimesh_object='dagmc.h5m',
    plane_normal=[0, 1, 0],
    rotate_plot=45,
)

plot.savefig('my_plot3.png', dpi=600)

Saves a png image of a plot of a slice through the geometry perpendicular to the X axis and with default settings elsewhere.

from dagmc_geometry_slice_plotter import plot_slice_of_dagmc_geometry

plot_slice_of_dagmc_geometry(
    dagmc_file_or_trimesh_object='dagmc.h5m',
    plane_normal = [1, 0, 0],
    rotate_plot=270,
    output_filename='my_plot4.png'
)

Related packages

This package is used by the regular_mesh_plotter Python package to combine slice plots with regular mesh tally results and produce images like below.

Comments

Some funky PyQT errors?

Pip installed and got the following error;

~/.local/lib/python3.10/site-packages/IPython/external/qt_loaders.py in load_qt(api_options)
    370         return result
    371     else:
--> 372         raise ImportError("""
    373     Could not load requested Qt binding. Please ensure that
    374     PyQt4 >= 4.7, PyQt5, PySide >= 1.0.3 or PySide2 is available,

ImportError: 
    Could not load requested Qt binding. Please ensure that
    PyQt4 >= 4.7, PyQt5, PySide >= 1.0.3 or PySide2 is available,
    and only one is imported per session.

    Currently-imported Qt library:                              'pyqt5'
    PyQt4 available (requires QtCore, QtGui, QtSvg):            False
    PyQt5 available (requires QtCore, QtGui, QtSvg, QtWidgets): False
    PySide >= 1.0.3 installed:                                  False
    PySide2 installed:                                          True
    Tried to load:

But, I do have pyqt5 & PySide2 installed

opened by makeclean 1

added single function that works for file or object

Adds a function called plot_slice_of_dagmc_geometry that can accept either a dagmc file name or a trimesh object and then produce a plot.

This provides a single entry function for users

opened by shimwell 1
adopted latest py packaging approach

A while back I updated this package from a setup.py to use a setup.cfg and a pyproject.toml.

It is now possible to do everything in the pyproject.toml so this PR updates the packages

opened by shimwell 0
remove internal plotting methods

returning the mplt object and then using the mplt savefig() method offers more flexibility then the built in function offers.

We can remove the internal function and reduce the code base a bit while maintaining the same functionalilty

opened by shimwell 0
adding ability to make animation

It would be handy if the slicer can make an animation

Perhaps it could accept a tuple for some of these inputs of plane_origin, plane_normal, rotate_plot and then make an animation that sweeps between the inputs.

A nice tutorial on mpl animations can be found here https://brushingupscience.com/2016/06/21/matplotlib-animations-the-easy-way/

opened by shimwell 0
setuptools_scm is required in setup.cfg

I might have done something incorrect with the setup.cfg / pyprogject.toml as it appears necessary to add setuptools_scm to the setup.cfg file.

Without this package the CI fails https://github.com/fusion-energy/dagmc_geometry_slice_plotter/runs/5336107961?check_suite_focus=true

With the package the CI passes https://github.com/fusion-energy/dagmc_geometry_slice_plotter/runs/5336124187?check_suite_focus=true

I tested the removal of this package in this PR https://github.com/fusion-energy/dagmc_geometry_slice_plotter/pull/14

I'm just not sure why it setuptools_scm is needed as this is not the case for other packages I've translated to setup.cfg

opened by shimwell 0

Releases(0.2.1)

0.2.1(Dec 13, 2022)
What's Changed

added axis labels by @shimwell in https://github.com/fusion-energy/dagmc_geometry_slice_plotter/pull/28

Full Changelog: https://github.com/fusion-energy/dagmc_geometry_slice_plotter/compare/0.2.0...0.2.1
Source code(tar.gz)
Source code(zip)
0.2.0(Dec 2, 2022)
What's Changed

removed unused script by @shimwell in https://github.com/fusion-energy/dagmc_geometry_slice_plotter/pull/25

moved to src project layout by @shimwell in https://github.com/fusion-energy/dagmc_geometry_slice_plotter/pull/26

refactoring to allow axis aligned plots by @shimwell in https://github.com/fusion-energy/dagmc_geometry_slice_plotter/pull/27

Full Changelog: https://github.com/fusion-energy/dagmc_geometry_slice_plotter/compare/0.1.3...0.2.0
Source code(tar.gz)
Source code(zip)
0.1.3(Sep 29, 2022)
What's Changed

removed packages that are installed by pyproject by @shimwell in https://github.com/fusion-energy/dagmc_geometry_slice_plotter/pull/22

added build back by @shimwell in https://github.com/fusion-energy/dagmc_geometry_slice_plotter/pull/23

added missing run cmd by @shimwell in https://github.com/fusion-energy/dagmc_geometry_slice_plotter/pull/24

Full Changelog: https://github.com/fusion-energy/dagmc_geometry_slice_plotter/compare/0.1.2...0.1.3
Source code(tar.gz)
Source code(zip)
0.1.2(Sep 29, 2022)
What's Changed

adopted latest py packaging approach by @shimwell in https://github.com/fusion-energy/dagmc_geometry_slice_plotter/pull/20

updating package production by @shimwell in https://github.com/fusion-energy/dagmc_geometry_slice_plotter/pull/21

Full Changelog: https://github.com/fusion-energy/dagmc_geometry_slice_plotter/compare/0.1.1...0.1.2
Source code(tar.gz)
Source code(zip)
0.1.1(Mar 7, 2022)
What's Changed

fixed typo in package name by @shimwell in https://github.com/fusion-energy/dagmc_geometry_slice_plotter/pull/19

Full Changelog: https://github.com/fusion-energy/dagmc_geometry_slice_plotter/compare/0.1.0...0.1.1
Source code(tar.gz)
Source code(zip)
0.1.0(Feb 25, 2022)
What's Changed

updated to setup.cfg by @shimwell in https://github.com/fusion-energy/dagmc_geometry_slice_plotter/pull/13

Added more python versions to the testing by @shimwell in https://github.com/fusion-energy/dagmc_geometry_slice_plotter/pull/14

removed output filename option by @shimwell in https://github.com/fusion-energy/dagmc_geometry_slice_plotter/pull/18

Full Changelog: https://github.com/fusion-energy/dagmc_geometry_slice_plotter/compare/v0.0.5...0.1.0
Source code(tar.gz)
Source code(zip)

Owner

Fusion Energy

A collection of software projects related to fusion energy

GitHub Repository

A minimal Python package that produces slice plots through h5m DAGMC geometry files

Related tags

Overview

Installation

Python API Usage

Related packages

Comments

Some funky PyQT errors?

added single function that works for file or object

adopted latest py packaging approach

remove internal plotting methods

adding ability to make animation

setuptools_scm is required in setup.cfg

Releases(0.2.1)

0.2.1(Dec 13, 2022)

What's Changed

0.2.0(Dec 2, 2022)

What's Changed

0.1.3(Sep 29, 2022)

What's Changed

0.1.2(Sep 29, 2022)

What's Changed

0.1.1(Mar 7, 2022)

What's Changed

0.1.0(Feb 25, 2022)

What's Changed

Owner

Fusion Energy

Simple addon for snapping active object to mesh ground

Generate SVG (dark/light) images visualizing (private/public) GitHub repo statistics for profile/website.

Some method of processing point cloud

This is a sorting visualizer made with Tkinter.

Fast scatter density plots for Matplotlib

Colormaps for astronomers

Collection of scripts for making high quality beautiful math-related posters.

Plotly Dash Command Line Tools - Easily create and deploy Plotly Dash projects from templates

GUI for visualization and interactive editing of SMPL-family body models ie. SMPL, SMPL-X, MANO, FLAME.

PyPassword is a simple follow up to PyPassphrase

FURY - A software library for scientific visualization in Python

Log visualizer for whirl-framework

Mathematical learnings with Lean, for those of us who wish we knew more of both!

Make visual music sheets for thatskygame (graphical representations of the Sky keyboard)

This is a Cross-Platform Plot Manager for Chia Plotting that is simple, easy-to-use, and reliable.

A package for plotting maps in R with ggplot2

A guide for using Bootstrap 5 classes in Dash Bootstrap Components V1

Streaming pivot visualization via WebAssembly

Handout for the tutorial "Creating publication-quality figures with matplotlib"

A curated list of awesome Dash (plotly) resources