hydromt.data_adapter.DatasetAdapter#

DatasetAdapter for non-spatial n-dimensional data.

Initiate data adapter for n-dimensional timeseries data.

This object contains all properties required to read supported files(netcdf, zarr) into a single unified Dataset, i.e. xarray.Dataset. In addition it keeps meta data to be able to reproduce which data is used.

Parameters:

path (str, Path) – Path to data source. If the dataset consists of multiple files, the path may contain {variable}, {year}, {month} placeholders as well as path search pattern using a * wildcard.
driver ({'netcdf', 'zarr'}, optional) – Driver to read files with, for ‘netcdf’ xarray.open_mfdataset(). By default the driver is inferred from the file extension.
filesystem (str, optional) – Filesystem where the data is stored (local, cloud, http etc.). If None (default) the filesystem is inferred from the path. See fsspec.registry.known_implementations() for all options.
nodata (float, int, optional) – Missing value number. Only used if the data has no native missing value. Nodata values can be differentiated between variables using a dictionary.
rename (dict, optional) – Mapping of native data source variable to output source variable name as required by hydroMT.
unit_mult (dict, optional) – Scaling multiplication and addition to change to map from the native data unit to the output data unit as required by hydroMT.
unit_add (dict, optional) – Scaling multiplication and addition to change to map from the native data unit to the output data unit as required by hydroMT.
meta (dict, optional) – Metadata information of dataset, prefably containing the following keys: - ‘source_version’ - ‘source_url’ - ‘source_license’ - ‘paper_ref’ - ‘paper_doi’ - ‘category’
placeholders (dict, optional) – Placeholders to expand yaml entry to multiple entries (name and path) based on placeholder values
attrs (dict, optional) – Additional attributes relating to data variables. For instance unit or long name of the variable.
driver_kwargs – Additional key-word arguments passed to the driver.
dict – Additional key-word arguments passed to the driver.
optional – Additional key-word arguments passed to the driver.
storage_options (dict, optional) – Additional key-word arguments passed to the fsspec FileSystem object.
name (str, optional) – Name of the dataset and catalog, optional.
catalog_name (str, optional) – Name of the dataset and catalog, optional.
provider (str, optional) – A name to identifiy the specific provider of the dataset requested. if None is provided, the last added source will be used.
version (str, optional) – A name to identifiy the specific version of the dataset requested. if None is provided, the last added source will be used.

Initiate data adapter for n-dimensional timeseries data.

Parameters:

path (str, Path) – Path to data source. If the dataset consists of multiple files, the path may contain {variable}, {year}, {month} placeholders as well as path search pattern using a * wildcard.
driver ({'netcdf', 'zarr'}, optional) – Driver to read files with, for ‘netcdf’ xarray.open_mfdataset(). By default the driver is inferred from the file extension.
filesystem (str, optional) – Filesystem where the data is stored (local, cloud, http etc.). If None (default) the filesystem is inferred from the path. See fsspec.registry.known_implementations() for all options.
nodata (float, int, optional) – Missing value number. Only used if the data has no native missing value. Nodata values can be differentiated between variables using a dictionary.
rename (dict, optional) – Mapping of native data source variable to output source variable name as required by hydroMT.
unit_mult (dict, optional) – Scaling multiplication and addition to change to map from the native data unit to the output data unit as required by hydroMT.
unit_add (dict, optional) – Scaling multiplication and addition to change to map from the native data unit to the output data unit as required by hydroMT.
meta (dict, optional) – Metadata information of dataset, prefably containing the following keys: - ‘source_version’ - ‘source_url’ - ‘source_license’ - ‘paper_ref’ - ‘paper_doi’ - ‘category’
placeholders (dict, optional) – Placeholders to expand yaml entry to multiple entries (name and path) based on placeholder values
attrs (dict, optional) – Additional attributes relating to data variables. For instance unit or long name of the variable.
driver_kwargs – Additional key-word arguments passed to the driver.
dict – Additional key-word arguments passed to the driver.
optional – Additional key-word arguments passed to the driver.
storage_options (dict, optional) – Additional key-word arguments passed to the fsspec FileSystem object.
name (str, optional) – Name of the dataset and catalog, optional.
catalog_name (str, optional) – Name of the dataset and catalog, optional.
provider (str, optional) – A name to identifiy the specific provider of the dataset requested. if None is provided, the last added source will be used.
version (str, optional) – A name to identifiy the specific version of the dataset requested. if None is provided, the last added source will be used.

Methods

`__init__`(path[, driver, filesystem, nodata, ...])	Initiate data adapter for n-dimensional timeseries data.
`get_data`([variables, time_tuple, ...])	Return a clipped, sliced and unified Dataset.
`get_time_range`([ds])	Get the temporal range of a dataset.
`mark_as_used`()	Mark the data adapter as used.
`summary`()	Return a dictionary summary of the data adapter.
`to_dict`()	Return a dictionary view of the data source.
`to_file`(data_root, data_name[, time_tuple, ...])	Save a dataset slice to file.
`to_stac_catalog`([on_error])	Convert a dataset into a STAC Catalog representation.

Attributes

`data_type`	Return the datatype of the addapter.
`fs`	Return the filesystem object .