Skip to content

Latest commit

 

History

History
25 lines (17 loc) · 1.28 KB

README.md

File metadata and controls

25 lines (17 loc) · 1.28 KB

plotpal

Post-processing tools for plotting results from Dedalus simulations. The code in this repository is backed up on Zenodo, and is citeable at: DOI

Installation

To install plotpal on your local machine, navigate to the root plotpal/ directory (where setup.py is located), and type:

pip3 install -e .

Note that plotpal is built on matplotlib, and uses some parallel functionality of Dedalus.

Dependencies

Plotpal relies on the full Dedalus stack (e.g., numpy, matplotlib, and dedalus itself) for full functionality.

Some additional features also rely on:

  • Volumetric plotting requires PyVista >= 0.38.5.
  • Orthographic projections require CartoPy.

Usage

  1. Copy one of the python scripts from the example/ directory somewhere closer to where you're running dedalus simulations (or just modify one of your local files there).
  2. Put in the fields you care about plotting.
  3. Make some plots!

By default, plots will be located within the parent directory of your Dedalus simulation, in a new folder.