PlasmaCalcs.addons.instability_tools.instability_theory_tools.xarray_stack_nonk_dims

PlasmaCalcs.addons.instability_tools.instability_theory_tools.xarray_stack_nonk_dims(growth, target=None, stackdim='nonk', *, order=None)

return target stacked along nonk dims.

growth: DataArray or Dataset

xarray object containing growth info.

real DataArray –> growth tells growth rates.

complex DataArray –> growth tells omega; rates = omega.imag.

Dataset –> growth rates = ds[‘omega’].imag

target: None, str, DataArray, or Dataset

xarray object of interest.

stackdim: str

name of the new stacked dimension.

order: None or list of str

if provided, prefer dimensions in this order.

all dims not in order will be sorted alphabetically.

Examples:

dsR = xr.Dataset(…) # dataset containing omega and maybe some other values

dsR.it.nonk_stack() # dataset, stacking all nonk_dims

dsR.it.nonk_stack(array) # array, stacking all nonk_dims