CoordinateSystemIOMixin#

class coordinates.mixins.core.CoordinateSystemIOMixin[source]#

Mixin class for coordinates.core.CurvilinearCoordinateSystem that provides serialization support for saving and loading coordinate systems to and from HDF5.

This mixin implements convenient methods for persisting coordinate system instances, including all user-specified parameters, to HDF5 files. It supports both flat and group-based storage within the file, and includes registry-aware deserialization to recover the correct class type.

Key Capabilities#

  • Save a coordinate system instance to disk with to_hdf5().

  • Restore a coordinate system instance from disk with from_hdf5().

  • Automatically serialize parameters, including support for JSON-encoded complex values.

  • Supports hierarchical group-based storage in HDF5 files.

  • Uses a registry to resolve class names to actual coordinate system types on load.

Methods

__init__()

from_hdf5(filename[, group_name, registry])

Save this coordinate system to HDF5.

to_hdf5(filename[, group_name, overwrite])

Save this coordinate system to HDF5.