Drivers#

The Hydromt drivers module provides drivers for various datasets and formats. Each driver implements read and optionally write methods, along with configuration options and a file system handler.

FileSystem#

All drivers rely on shared type definitions from hydromt.typing.

FSSpecFileSystem

Pydantic compatible fsspec AbstractFileSystem.

Driver Base Classes#

`BaseDriver`	Base class for different drivers.
`DriverOptions`	Options for the driver.

Raster Data Drivers#

`RasterDatasetDriver`	Abstract Driver to read GeoDataFrames.
`RasterDatasetXarrayDriver`	Driver for RasterDataset using the xarray library: `raster_xarray`.
`RasterXarrayOptions`	Options for RasterXarrayDriver.
`RasterioDriver`	Driver for RasterDataset using the rasterio library: `rasterio`.
`RasterioOptions`	Options for RasterioDriver.

Vector & Geospatial Drivers#

`GeoDataFrameDriver`	Abstract Driver to read GeoDataFrames.
`PyogrioDriver`	Driver for GeoDataFrame using the pyogrio library: `pyogrio`.
`GeoDataFrameTableDriver`	Driver for GeoDataFrame from tabular formats: `geodataframe_table`.
`GeoDataFrameTableOptions`	Options for the GeoDataFrameTableDriver.

Tabular Data Drivers#

`DataFrameDriver`	Abstract Driver to read DataFrames.
`PandasDriver`	Driver for DataFrames using the pandas library: `pandas`.

Geospatial Dataset Drivers#

`GeoDatasetDriver`	Abstract Driver to read GeoDatasets.
`GeoDatasetOptions`	Options for GeoDatasetVectorDriver.
`GeoDatasetXarrayDriver`	Driver for GeoDataset using the xarray library: `geodataset_xarray`.
`GeoDatasetVectorDriver`	Driver for GeoDataset using hydromt vector: `geodataframe_vector`.

General Dataset Drivers#

`DatasetDriver`	Abstract Driver to read Datasets.
`DatasetXarrayDriver`	Driver for Dataset using xarray: `dataset_xarray`.
`DatasetXarrayOptions`	Options for DatasetXarrayDriver.

Preprocessing#

`preprocessing.harmonise_dims`(ds)	Harmonise lon-lat-time dimensions.
`preprocessing.remove_duplicates`(ds)	Remove duplicates from the 'time' index.
`preprocessing.round_latlon`(ds[, decimals])	Round the x and y dimensions to latlon.
`preprocessing.to_datetimeindex`(ds)	Convert the 'time' index to datetimeindex.