hydromt.data_catalog.drivers.RasterioDriver#

class hydromt.data_catalog.drivers.RasterioDriver(*, filesystem: ~fsspec.spec.Annotated[~fsspec.spec.AbstractFileSystem, ~pydantic.functional_validators.PlainValidator(func=~hydromt._typing.fsspec_types.validate_filesystem, json_schema_input_type=~typing.Any), ~pydantic.functional_serializers.PlainSerializer(func=~hydromt._typing.fsspec_types.serialize_filesystem, return_type=PydanticUndefined, when_used=always)] = <factory>, options: ~typing.Dict[str, ~typing.Any] = <factory>)[source]#

Driver for RasterDataset using the rasterio library: rasterio.

Supports reading and writing raster files using rasterio.

Driver options include:

  • mosaic: bool, if True and multiple uris are given, will mosaic the datasets together using rasterio.merge.merge. Default is False.

  • mosaic_kwargs: dict, additional keyword arguments to pass to rasterio.merge.merge.

  • cache: bool, if True and reading from VRT files, will cache the tiles locally to speed up reading. Default is False.

  • cache_root: str, root directory for caching. Default is taken from hydromt.config.SETTINGS.cache_root.

  • cache_dir: str, subdirectory for caching. Default is the stem of the first uri without extension.

  • Any other option supported by hydromt.io.readers.open_mfraster.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__init__(**data: Any) → None#

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Methods

__init__(**data)

Create a new model by parsing and validating input data from keyword arguments.

construct([_fields_set])

copy(*[, include, exclude, update, deep])

Returns a copy of the model.

dict(*[, include, exclude, by_alias, ...])

find_all_possible_types()

Return all possible sub types for this object as an iterator.

from_orm(obj)

json(*[, include, exclude, by_alias, ...])

model_construct([_fields_set])

Creates a new instance of the Model class with validated data.

model_copy(*[, update, deep])

!!! abstract "Usage Documentation"

model_dump(*[, mode, include, exclude, ...])

!!! abstract "Usage Documentation"

model_dump_json(*[, indent, include, ...])

!!! abstract "Usage Documentation"

model_json_schema([by_alias, ref_template, ...])

Generates a JSON schema for a model class.

model_parametrized_name(params)

Compute the class name for parametrizations of generic classes.

model_post_init(context, /)

Override this method to perform additional initialization after __init__ and model_construct.

model_rebuild(*[, force, raise_errors, ...])

Try to rebuild the pydantic-core schema for the model.

model_validate(obj, *[, strict, ...])

Validate a pydantic model instance.

model_validate_json(json_data, *[, strict, ...])

!!! abstract "Usage Documentation"

model_validate_strings(obj, *[, strict, ...])

Validate the given object with string data against the Pydantic model.

parse_file(path, *[, content_type, ...])

parse_obj(obj)

parse_raw(b, *[, content_type, encoding, ...])

read(uris, *[, mask, time_range, variables, ...])

Read data using rasterio.

schema([by_alias, ref_template])

schema_json(*[, by_alias, ref_template])

update_forward_refs(**localns)

validate(value)

write(path, ds, **kwargs)

Write out a RasterDataset using rasterio.

Attributes

SUPPORTED_EXTENSIONS

model_computed_fields

model_config

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_extra

Get extra fields set during validation.

model_fields

model_fields_set

Returns the set of fields that have been explicitly set on this model instance.

name

supports_writing

filesystem

options