Zeltron AnAlysis with Python (ZAAPy)

-->

zaapy is a 2D visualization command line tool for Zeltron. It works with h5-formatted data from Zeltron and GRZeltron

Data Formats

Accepted formats for the data: GRZeltron: *.h5 Zeltron: *.h5

⚠️ 🚧 This project and documentation are under construction 🚧 ⚠️

Installation

⚠️ zaapy requires Python 3.8 or newer. Installation method:

$ pip install zaapy

Usage

Command line

The zaapy CLI gets its parameters from two sources:

• command line parameters
• default values

Command lines parameters take priority over default values.

To get help, run

$ zaapy --help

usage: zaapy [-h] [-dir DATADIR] [-field FIELD] [-it I1 I2 DT]
            [-vmin VMIN] [-vmax VMAX] [-cmap CMAP] [-dpi DPI]
            [-geom {cartesian, spherical}] [-d] [-log] [-range x x x x]
            [-spec SPEC] [-plane x x] [-title TITLE] [-fmt FMT]

optional arguments:
 -h,--help          show this help message and exit
 -dir DATADIR       location of output files and parameter files (default: '.')
 -field FIELD       field to plot
 -it I1,I2,DT       timesteps to plot
 -vmin VMIN         min value for colorbar
 -vmax VMAX         max value for colorbar
 -cmap CMAP         choice of colormap for the map
 -dpi DPI           image file resolution
 -geom              geometry of the simulation (choice: 'cartesian','spherical')
 -spec              species to load (default: 'electrons')
 -range             range of matplotlib window
 -plane             projection plane
 -title             name of the field in the colorbar
 -fmt               format of output image file

boolean flag:
 -log               plot the log10 of the field f, i.e. log(f)

CLI-only option:
 -d                 to display the plot, turned off if multiple timesteps to plot
 -version           display version number

Python module

zaapy can be used as a python module to load and work with data from simulation done with Zeltron.

from zaapy.api import GasDataSet,compute

ds=GasDataSet()

Contribute

We use pre-commit hooks to format the code in order to reduce bad coding behaviour

Support

If you face an issue or a bug (might just be a feature 😉), please report it as an issue on this repository

Authors and acknowledgment

Author: Adrien Soudais

Acknowledgments: Gaylor Wafflard-Fernandez, Clément Robert, Ileyk El Mellah

License

GNU GENERAL PUBLIC LICENSE

Project status

Still under development