data

Module for fetching HDF5 assets used through examples.

This module uses the pooch library to manage the downloading and caching of HDF4 and HDF5 files that adhere to PSI data conventions. It defines functions to fetch specific example datasets, including 1D radial scale data, 2D coronal hole maps, 3D radial magnetic field data, magnetic fieldline data, and synchronic maps used in coronal and heliospheric magnetic field modeling.

Currently, these files are hosted on the PredSci documentation website: at https://www.predsci.com/doc/assets/ and are primarily intended for use in building examples in the PSI I/O and mapflpy packages.

Functions

check_hdf_type(func)
file_ids()	List all available magnetic field files in the registry.
get_1d_data([hdf])	Fetch the radial scale (1D) data file.
get_2d_data([hdf])	Fetch the coronal hole map (2D) data file.
get_3d_data([hdf])	Fetch the radial magnetic field (3D) data file.
get_fieldline_data([hdf])	Fetch the magnetic fieldline (2D) data file.
get_synchronic_map_data([hdf])	Fetch the synchronic map data file.

Attributes

BASE_URL	Base URL hosting magnetic field file assets.
FETCHER	Pooch fetcher for downloading and caching magnetic field files.
REGISTRY	Registry of available magnetic field files with their SHA256 hashes.