Installation

Installation#

Attention

We highly recommend using a virtual environment to manage your Python packages and avoid conflicts with other projects. For the best results, we recommend using conda – via Miniforge (preferred), Miniconda, or Anaconda – to create and manage your virtual environments.

To get started with psi-data-utils, you can install it directly from PyPI:

pip install psi-data-utils

This installs the package along with its only hard runtime dependency, pooch, which manages downloading and caching the data files.

Required Dependencies#

  • Python >= 3.8

  • pooch — installed with the [progress] extra so that downloads display a progress bar.

Companion Packages#

psi-data-utils only retrieves data files; reading, analyzing, and visualizing them is handled by the rest of the PSI Python ecosystem. The following packages are not required to install or use psi-data-utils, but are the natural next steps once the data are on disk:

  • psi-io — read and write PSI HDF4/HDF5 files and load coordinate-aware MHD model output.

  • mapflpy — trace magnetic field lines through MAS and POT3D vector fields.

  • pyvisual (PyPI: psi-pyvisual) — interactive 3-D visualization of spherical MHD model output.

Contents