Skip to content

BenWibking/plotfile-viewer

Repository files navigation

plotfile-viewer [WIP]

This package is currently a work-in-progress. Bugs are expected, and bug reports are welcome.

Requires pyAMReX 24.07+.

Overview

The proof-of-concept use case is to view a timeseries of 2D slices produced by the DiagFramePlane diagnostic output by PeleLMeX and Quokka.

This package contains a set of tools to load and visualize the contents of a timeseries of AMReX plotfiles.

Screenshot

Screenshot

Features

  • 2D Cartesian plotfiles (level 0 only)
  • 3D Cartesian plotfiles (level 0 only)

Roadmap

  • Plot refined levels
  • Particles
  • Lazy loading of FABs (when the plotfiles are large)
  • Lazy loading of ParticleTiles

Installation

Installation with pip

You can install plotfile-viewer using pip:

pip install git+https://github.com/BenWibking/plotfile-viewer

Usage

This package is currently a work-in-progress. Bugs are expected, and bug reports are welcome.

If you wish to use the interactive GUI, the installation of plotfile-viewer provides a convenient executable which automatically creates a new pre-filled notebook and opens it in a browser. To use this executable, simply type in a regular terminal:

plotfile_notebook

(This executable is installed by default, when installing plotfile-viewer.)

Acknowledgement

We thank openPMD-viewer for providing the inspiration (and original codebase) for this project.

About

AMReX plotfile viewer [WIP]

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published