PLUTOOutput

class psipy.model.pluto.PLUTOOutput(path)

Bases: ModelOutput

The results from a single run of PLUTO.

This is a storage object that contains a number of Variable objects. It is designed to be used like:

pluto_output = PLUTOOutput('directory')
br = pluto_output['br']

Notes

Variables are loaded on demand. To see the list of available variables use PLUTOOutput.variables, and to see the list of already loaded variables use PLUTOOutput.loaded_variables.

Attributes Summary

loaded_variables	List of loaded variable names.
variables	List of all variable names present in the directory.

Methods Summary

cell_corner_b([t_idx])	Get the magnetic field vector at the cell corners.
get_runit()	Return the units for the radial coordiate.
get_unit(var)	Return the units for a variable, and the factor needed to convert from the model output to those units.
get_variables()	Returns
load_file(var)	Load data for variable var.

Attributes Documentation

loaded_variables

List of loaded variable names.

variables

List of all variable names present in the directory.

Methods Documentation

cell_corner_b(t_idx: Optional[int] = None) → DataArray

Get the magnetic field vector at the cell corners.

Parameters

t_idxint, optional

If more than one timestep is present in the loaded model, a timestep index at which to get the vectors must be provided.

Returns

xarray.DataArray

Notes

The phi limits go from 0 to 2pi inclusive, with the vectors at phi=0 equal to the vectors at phi=2pi.

get_runit()

Return the units for the radial coordiate.

Returns

unitastropy.units.Unit

get_unit(var)

Return the units for a variable, and the factor needed to convert from the model output to those units.

Returns

unitastropy.units.Unit

factorfloat

get_variables()

Returns

list

A list of all variable names present in the directory.

load_file(var)

Load data for variable var.