API reference

psipy.model.mas Module

Classes

MASOutput(path)

The results from a single run of MAS.

psipy.model.pluto Module

Classes

PLUTOOutput(path)

The results from a single run of PLUTO.

psipy.model.variable Module

Classes

Variable(data, name, unit)

A single scalar variable.

psipy.model.base Module

Classes

ModelOutput(path)

The results from a single model run.

psipy.tracing Package

Classes

FieldLine(*, r, lat, lon)

A single field line.

FieldLines(xs)

A container for multiple field lines.

FortranTracer([max_steps, step_size])

Tracer using Fortran code.

psipy.io.mas Module

Tools for reading MAS (Magnetohydrodynamics on a sphere) model outputs.

Files come in two types, .hdf or .h5. In both cases filenames always have the structure ‘{var}{timestep}.{extension}’, where:

  • ‘var’ is the variable name

  • ‘timestep’ is the three digit (zero padded) timestep

  • ‘extension’ is ‘.hdf’ or ‘.h5’

Functions

read_mas_file(directory, var)

Read in a set of MAS output files.

get_mas_variables(path)

Return a list of variables present in a given directory.

convert_hdf_to_netcdf(directory, var)

Read in a set of HDF files, and save them out to NetCDF files.

psipy.io.pluto Module

Tools for reading pluto model outputs.

Functions

read_pluto_files(directory, var)

Read in a single variable from a set of PLUTO output files.

get_pluto_variables(directory)

Return a list of variables present in a given directory.

read_pluto_grid(path)

Read in a single PLUTO grid file.

psipy.io.util Module

Functions

read_hdf4(path[, sds_id])

Read a HDF4 file.

read_hdf5(path[, dataset_name])

Read a HDF5 file.

psipy.visualization.pyvista Module

Classes

MASPlotter(mas_output)

Wrapper for a pyvista.Plotter.

psipy.data Package

Functions

mas_helio_timesteps()

Get two MAS heliospheric data files for two subsequent Carrington rotations.

mas_sample_data([type])

Get some MAS data files.