Utilities¶

Coordinate Utilities¶

A collection of utilities to manipulate and check coordinate systems dictionaries.

`utils.coords.handshake_dim`	Simple check to see if coordinate system has a dimension in a particular index
`utils.coords.handshake_coords`	Simple check to see if the required dimensions have the same coordinate system
`utils.coords.handshake_size`	Simple check to see if a coordinate system of a given dimension is a required size
`utils.coords.map_coords`	A basic interpolation util to map between coordinate systems with common dimensions.
`utils.coords.split_coords`	A utility function to split a dimension from a (x,coords) pair and convert it into a list of tensors, a CoordSystem, and the dimension that extract from coords.

utils.interp.LatLonInterpolation Bilinear interpolation between arbitrary grids.

utils.obs.ObsGridMapping Maps point observations to and from a 2-D model grid.

`utils.time.timearray_to_datetime`	Simple converter from numpy datetime64 array into a list of datetimes.
`utils.time.to_time_array`	A general converter for various time iterables into a numpy datetime64 array

`utils.checkpoint.Checkpoint`	Catalog of restart checkpoints for a named inference run.
`utils.checkpoint.CheckpointSession`	Active checkpoint row or new checkpoint session.
`utils.checkpoint.CheckpointState`	Bound checkpoint state proxy returned by `bind_checkpoint_state`.
`utils.checkpoint.NullCheckpoint`	No-op checkpoint used when checkpointing is disabled.

utils.checkpoint.bind_checkpoint_state Bind a dataclass instance to checkpoint state metadata.

`data.datasource_to_file`	Utility function that can be used for building a local data store needed for an inference request.
`data.fetch_data`	Utility function to fetch data arrays from particular sources and load data on the target device.
`data.prep_data_array`	Prepares a data array from a data source for inference workflows by converting the data array to a torch tensor and the coordinate system to an OrderedDict.

`auto.Package`	A generic file system abstraction with local caching, uses Fsspec WholeFileCacheFileSystem to manage files.
`batch.batch_func`	Batch utility decorator which can be added to prognostic and diagnostic models to help enable support for automatic batching of data.