Welcome to PyPLUTO’s documentation!

PyPLUTO is a Python library which loads and plots the data obtained from the PLUTO code simulations. The aim of this package is to simplify some non-trivial Python routines in order to quickly recover effective plots that are suited for scientific publications. Physical units can be attached to loaded variables via the astropy library.

Note

This project is under active development.

---

Contents

• Install
  • From PyPI
  • With uv
  • With conda
  • From Source
  • Issues
• Loading
  • Loading the fluid files
  • Loading the particles files
  • A note on the PLUTO output
  • Physical units
  • What about other codes?
• Manipulating
  • Variables and grid conversion
  • Field and contour lines tool
  • Fourier Transform
  • Derivatives
  • Spectrum and select particles
  • Showing the plot windows
  • Controlling output verbosity
• Plotting
  • Subplots creation and customization
  • The plotting procedure
  • Field and contour lines
  • Interactive plots
  • Useful plotting tools
  • AMR blocks
• GUI
  • GUI Installation
  • Load the data with the GUI
  • Selecting the variable with the GUI
  • Plotting the data with the GUI
  • Examples with the GUI
    • GUI Example 1: Sod
      • Phase 1 (sod): Loading the data
      • Phase 2 (sod): Selecting the variable
      • Phase 3 (sod): Plotting the data
    • GUI Example 2: OT vortex
      • Phase 1 (ot): Loading the data
      • Phase 2 (ot): Selecting the variable
      • Phase 3 (ot): Plotting the data
• Examples
  • Test 01 - HD Sod shock tube
  • Test 02 - MHD Orszag-Tang vortex
  • Test 03 - MHD Rayleigh-Taylor instability
  • Test 04 - MHD Rotor test
  • Test 05 - MHD Field loop test
  • Test 06 - HD Disk planet test
  • Test 07 - RMHD Kelvin-Helmholtz instability test
  • Test 08 - MHD Torus test
  • Test 09 - MHD Blast test
  • Test 10 - HD Riemann 2D test
  • Test 11 - Particles CR Xpoint test
  • Test 12 - LP Riemann 2D test
  • Test 13 - AMR Flow past cylinder test
• FAQs
  • How do I install PyPLUTO?
  • Can I use PyPLUTO with Python 3.9 or 3.10?
  • What file formats does PyPLUTO support?
  • What is the difference between Load and LoadPart?
  • Can I use PyPLUTO without having the PLUTO code installed?
  • How do I attach physical units to loaded variables?
  • How do I define custom variables in the GUI?
  • Can I use PyPLUTO with simulation codes other than PLUTO?
  • How do I create 1D and 2D plots with the Image class?
  • How do I create a figure with multiple subplots?
  • How do I create interactive or animated plots?
  • How do I plot field lines and contour lines?
  • How do I report a bug or request a feature?
• Contribute
  • Code of Conduct
  • Use of AI
  • Prerequisites
  • Local Setup
  • Pre-commit and Quality Checks
  • Type checking
  • Running Tests
  • Documentation
  • Workflow for Pull Requests
  • Project Structure
  • Questions

---

Indices and tables

• Index

• Search Page

---