psi_data

Contents

psi_data#

Sample data fetching and management utilities for Predictive Science Inc.

This package provides thin, cached download helpers for PSI sample datasets — MHD model output from MAS and POT3D runs plus standalone example files. Files are downloaded on demand into a local pooch cache and verified against packaged checksums, so repeated calls are cheap.

Examples#

>>> import psi_data
>>> paths = psi_data.fetch_mas_data(domains="cor", variables="br")
>>> paths.cor_br
PosixPath('.../cor/mhd/br002.h5')

Functions

clear_psi_cache([dry_run, prompt])

Delete cached data files downloaded by the fetch_* helpers.

fetch_all(*[, hdf])

Fetch every registry file matching the requested HDF version.

fetch_example_chmapdb(*[, hdf])

Fetch the bundled example coronal-hole map database, if available.

fetch_example_fieldline(*[, hdf])

Fetch the bundled example magnetic field line trace data file.

fetch_example_radial_scale(*[, hdf])

Fetch the bundled example radial scaling data file.

fetch_mas_data(*[, domains, variables, hdf])

Fetch MAS magnetohydrodynamic model output for the given domains and variables.

fetch_mas_quantities(*[, quantities, hdf])

Fetch derived MAS quantities defined at the model inner radial boundary.

fetch_pot3d_data(*[, variables, hdf])

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

Exceptions

RegistryWarning

Warning emitted when a requested data file is unavailable.
Contents