Skip to main content
Ctrl+K

psi-io v2.1.0

  • PSI Home
  • Repository
  • Documentation
  • Contact
  • API
    • psi_io
      • _mesh
        • Mesh
        • remesh_array
        • ArrayOrdering
        • MeshCodeType
      • _models
        • Props
        • extract_quantity_from_filepath
        • extract_sequence_from_filepath
        • get_mas_quantity_properties
        • get_model_prop_caller
        • get_pot3d_quantity_properties
        • get_psi_scale_properties
        • parse_psi_filename_schema
        • MasQuantities
        • ModelType
        • Pot3dQuantities
        • PsiScales
      • _units
        • compose_mas_units
        • decompose_mas_units
        • get_helium_fractions
        • BOLTZ
        • C_CGS
        • FAVORED_UNITS
        • FKSPITZ
        • FLUX_UNIT
        • FMP
        • FN0PHYS
        • FN_B
        • FN_E
        • FN_E_CGS
        • FN_FLUX
        • FN_HEAT
        • FN_J
        • FN_J_CGS
        • FN_JB
        • FN_KAPPA
        • FN_LENGTH
        • FN_N
        • FN_P
        • FN_QRAD
        • FN_RHO
        • FN_T
        • FN_TIME
        • FN_V
        • FNORML
        • FNORMM
        • FNORMT
        • G0NORM
        • G0PHYS
        • K
        • MAS_b
        • MAS_heat
        • MAS_j
        • MAS_n
        • MAS_p
        • MAS_t
        • MAS_v
        • MU0
        • OMEGA_COROTATE
        • PI
        • POT3D_b
        • PSI_angle
        • PSI_rsun
        • RSUN
        • STATAMP_TO_AMPERE
        • STATVOLT_TO_VOLT
        • VOLUMETRIC_RATE_UNIT
        • W
      • data
        • check_hdf_type
        • file_ids
        • get_1d_data
        • get_2d_data
        • get_3d_data
        • get_fieldline_data
        • get_synchronic_map_data
        • _P
        • _R
        • BASE_URL
        • FETCHER
        • REGISTRY
      • mhd_io
        • PsiData
      • psi_io
        • HdfDataMeta
        • HdfScaleMeta
        • convert
        • convert_psih4_to_psih5
        • get_scales_1d
        • get_scales_2d
        • get_scales_3d
        • instantiate_linear_interpolator
        • interpolate_point_from_1d_slice
        • interpolate_point_from_2d_slice
        • interpolate_positions_from_hdf
        • np_interpolate_slice_from_hdf
        • rdhdf_1d
        • rdhdf_2d
        • rdhdf_3d
        • read_hdf_by_index
        • read_hdf_by_ivalue
        • read_hdf_by_value
        • read_hdf_data
        • read_hdf_meta
        • read_rtp_meta
        • sp_interpolate_slice_from_hdf
        • wrhdf_1d
        • wrhdf_2d
        • wrhdf_3d
        • write_hdf_data
        • write_hdf_meta
        • HDFEXT
        • HdfExtType
        • PathLike
        • PSI_DATA_ID
        • PSI_SCALE_ID
        • SDC_TYPE_CONVERSIONS
  • Guide
    • Installation
    • Overview
  • Examples
    • Reading Files
      • Reading HDF5 File Metadata
      • Reading Full Datasets
      • Reading Subsets of Datasets
      • Interpolating Datasets
    • Writing Files
      • Writing Simple Datasets
      • Writing Datasets with Attributes
      • Converting Between HDF4 and HDF5
      • Annotating and Converting the Radial Magnetic Field
    • MHD Model Output
      • Opening MHD Model Files with PsiData
      • Reading MHD Data: Units, Meshes, and Value-Space Slicing
  • .rst

User Guide

User Guide#

To get started with psi_io, please refer to the following sections:

  • Installation
    • Required Dependencies
    • Optional Dependencies
  • Overview
  • Quick Start
  • PSI Conventions
    • HDF4 Conventions
    • HDF5 Conventions
    • psi-io Conventions
  • PSI Model Quantities & Coordinate Scales
    • Coordinate scales
    • MAS model quantities
    • POT3D model quantities
  • Using psi-io

By Predictive Science Inc

© Copyright 2026, Predictive Science Inc.