fetch_pot3d_data

fetch_pot3d_data#

fetch_pot3d_data(*, variables='br', hdf=5)#

Fetch POT3D potential-field source-surface (PFSS) magnetic field components.

Downloads the POT3D PFSS solution components for the coronal domain and returns their cached paths.

Parameters:
variablesstr | Iterable | None, optional

Magnetic field component(s) to fetch: "br", "bt", "bp" (\(\mathbf{B}\)). Accepts a comma-separated string, an iterable of component names, or None to fetch all three components. Default is "br".

hdfint, optional

HDF format version to download: 4 (.hdf) or 5 (.h5). Default is 5.

Returns:
pathsFilepaths

Named tuple whose fields are the component names and whose values are the Path of each downloaded file.

Raises:
ValueError

If hdf is not a supported HDF version.

See also

fetch_mas_data

Fetch full MAS MHD field output.

Examples

>>> from psi_data import fetch_pot3d_data
>>> paths = fetch_pot3d_data(variables="br,bt,bp")
>>> paths.br
PosixPath('.../cor/pfss/br.h5')
Contents