API Reference¶

This section provides detailed API documentation for cfdb's public interface.

Entry Points¶

Function	Description
`open_dataset`	Open a local cfdb dataset
`open_edataset`	Open an S3-backed cfdb dataset

Core Classes¶

Class	Description
`Dataset`	Main dataset class (dict-like access to variables)
`EDataset`	S3-backed dataset (extends Dataset)
`Coordinate`	Coordinate variable (holds data in memory)
`DataVariable`	Data variable (chunk-based access)

Creation¶

Class	Description
`Creator`	Variable and CRS creation interface (`ds.create`)

Data Types¶

Function/Class	Description
`dtypes.dtype()`	Factory function for creating data types

Interpolation¶

Class	Description
`GridInterp`	Grid interpolation wrapper (grid datasets)
`PointInterp`	Point interpolation wrapper (ts_ortho datasets)

Rechunking¶

Class	Description
`Rechunker`	On-the-fly rechunking interface

Combining¶

Function	Description
`combine`	Merge multiple datasets into a new file
`merge_into`	Merge datasets in-place into an existing file

Tools¶

Function	Description
`cfdb_to_netcdf4`	Convert cfdb to netCDF4

Module Structure¶

cfdb/
├── __init__.py          # Public API: open_dataset, open_edataset, dtypes, etc.
├── main.py              # Dataset, DatasetView, open_dataset()
├── edataset.py          # EDataset, open_edataset()
├── support_classes.py   # Variable, Coordinate, DataVariable, Rechunker, etc.
├── creation.py          # Creator, Coord, DataVar, CRS
├── dtypes.py            # DataType hierarchy, dtype() factory
├── interp.py            # GridInterp / PointInterp wrappers
├── data_models.py       # msgspec Structs for metadata
├── indexers.py           # Index and location-based selection
├── combine.py           # Dataset out-of-place combining
├── merge.py             # Dataset in-place merging
├── tools.py             # NetCDF4 conversion functions
└── utils.py             # Internal utilities