Drivers#

Base#

BaseDriver(*, filesystem, ...)

Base class for different drivers.

RasterDataset#

RasterDatasetDriver(*, filesystem, ...)

Abstract Driver to read GeoDataFrames.

RasterDatasetDriver.read(uris, *[, mask, ...])

Read in any compatible data source to an xarray Dataset.

RasterDatasetDriver.write(path, ds, **kwargs)

Write out a RasterDataset to file.

RasterDatasetXarrayDriver#

RasterDatasetXarrayDriver(*, filesystem, ...)

Driver for RasterDataset using the xarray library: raster_xarray.

RasterDatasetXarrayDriver.read(uris, *[, ...])

Read zarr data to an xarray DataSet.

RasterDatasetXarrayDriver.write(path, ds, ...)

Write the RasterDataset to a local file using zarr.

RasterioDriver#

RasterioDriver(*, filesystem, ...)

Driver for RasterDataset using the rasterio library: rasterio.

RasterioDriver.read(uris, *[, mask, ...])

Read data using rasterio.

RasterioDriver.write(path, ds, **kwargs)

Write out a RasterDataset using rasterio.

GeoDataFrame#

GeoDataFrameDriver(*, filesystem, ...)

Abstract Driver to read GeoDataFrames.

GeoDataFrameDriver.read(uris, *[, metadata, ...])

Read in any compatible data source to a geopandas GeoDataFrame.

GeoDataFrameDriver.write(path, gdf, **kwargs)

Write out a GeoDataFrame to file.

PyogrioDriver#

PyogrioDriver(*, filesystem, ...)

Driver for GeoDataFrame using the pyogrio library: pyogrio.

PyogrioDriver.read(uris, *[, mask, ...])

Read data using pyogrio.

PyogrioDriver.write(path, gdf, **kwargs)

Write out a GeoDataFrame to file using pyogrio.

GeoDataFrameTableDriver#

GeoDataFrameTableDriver(*, filesystem, ...)

Driver for GeoDataFrame from tabular formats: geodataframe_table.

GeoDataFrameTableDriver.read(uris, *[, ...])

Read tabular data using a combination of the pandas and geopandas libraries.

GeoDataFrameTableDriver.write(path, gdf, ...)

Write out a GeoDataFrame to file.

DataFrame#

DataFrameDriver(*, filesystem, ...)

Abstract Driver to read DataFrames.

DataFrameDriver.read(uris, *[, variables, ...])

Read in any compatible data source to a pandas DataFrame.

DataFrameDriver.write(path, df, **kwargs)

Write out a DataFrame to file.

PandasDriver#

PandasDriver(*, filesystem, ...)

Driver for DataFrames using the pandas library: pandas.

PandasDriver.read(uris, *[, variables, ...])

Read in any compatible data source to a pandas DataFrame.

PandasDriver.write(path, df, **kwargs)

Write out a DataFrame to file.

GeoDataset#

GeoDatasetDriver(*, filesystem, ...)

Abstract Driver to read GeoDatasets.

GeoDatasetDriver.read(uris, *[, mask, ...])

Read in any compatible data source to an xarray Dataset.

GeoDatasetDriver.write(path, ds, **kwargs)

Write out a GeoDataset to file.

GeoDatasetXarrayDriver#

GeoDatasetXarrayDriver(*, filesystem, ...)

Driver for GeoDataset using the xarray library: geodataset_xarray.

GeoDatasetXarrayDriver.read(uris, *[, mask, ...])

Read zarr data to an xarray DataSet.

GeoDatasetXarrayDriver.write(path, ds, **kwargs)

Write the GeoDataset to a local file using zarr.

GeoDatasetVectorDriver#

GeoDatasetVectorDriver(*, filesystem, ...)

Driver for GeoDataset using hydromt vector: geodataframe_vector.

GeoDatasetVectorDriver.read(uris, *[, mask, ...])

Read tabular datafiles like csv or parquet into to an xarray DataSet.

GeoDatasetVectorDriver.write(path, ds, **kwargs)

Not implemented.

Dataset#

DatasetDriver(*, filesystem, ...)

Abstract Driver to read Datasets.

DatasetDriver.read(uris, *[, variables, ...])

Read in any compatible data source to an xarray Dataset.

DatasetDriver.write(path, ds, **kwargs)

Write out a Dataset to file.

DatasetXarrayDriver#

DatasetXarrayDriver(*, filesystem, ...)

Driver for Dataset using xarray: dataset_xarray.

DatasetXarrayDriver.read(uris, *[, ...])

Read zarr data to an xarray DataSet.

DatasetXarrayDriver.write(path, ds, **kwargs)

Write the Dataset to a local file using zarr.

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.