hydromt.GridModel#

class hydromt.GridModel(root: str | None = None, mode: str = 'w', config_fn: str | None = None, data_libs: ~typing.List[str] | None = None, logger=<Logger hydromt.models.model_grid (WARNING)>)[source]#

Model class Grid Model for gridded models in HydroMT

Initialize a GridModel for distributed models with a regular grid.

__init__(root: str | None = None, mode: str = 'w', config_fn: str | None = None, data_libs: ~typing.List[str] | None = None, logger=<Logger hydromt.models.model_grid (WARNING)>)[source]#: Initialize a GridModel for distributed models with a regular grid.

Methods

`__init__`([root, mode, config_fn, data_libs, ...])	Initialize a GridModel for distributed models with a regular grid.
`build`([region, write, opt])	Single method to build a model from scratch based on settings in opt.
`get_config`(*args[, fallback, abs_path])	Get a config value at key(s).
`read`([components])	Read the complete model schematization and configuration from model files.
`read_config`([config_fn])	Parse config from file.
`read_forcing`([fn])	Read forcing at <root>/<fn> and add to forcing property
`read_geoms`([fn])	Read model geometries files at <root>/<fn> and add to geoms property
`read_grid`([fn])	Read model grid data at <root>/<fn> and add to grid property
`read_maps`([fn])	Read model map at <root>/<fn> and add to maps component
`read_results`([fn])	Read results at <root>/<fn> and add to results property
`read_states`([fn])	Read states at <root>/<fn> and add to states property
`read_staticgeoms`()	This method will be deprecated in future versions, use `read_geoms()`
`read_staticmaps`([fn])	Read static model maps at <root>/<fn> and add to staticmaps property
`set_config`(*args)	Update the config dictionary at key(s) with values.
`set_crs`(crs)	Set coordinate reference system of the model grid.
`set_forcing`(data[, name, split_dataset])	Add data to forcing attribute.
`set_geoms`(geom, name)	Add data to the geoms attribute.
`set_grid`(data[, name])	Add data to grid.
`set_maps`(data[, name, split_dataset])	Add raster data to the maps component.
`set_results`(data[, name, split_dataset])	Add data to results attribute.
`set_root`(root[, mode])	Initialize the model root.
`set_states`(data[, name, split_dataset])	Add data to states attribute.
`set_staticgeoms`(geom, name)	This method will be deprecated in future versions, use `set_geoms()`
`set_staticmaps`(data[, name])	This method will be deprecated in future versions.
`setup_basemaps`(args, *kwargs)
`setup_config`(**cfdict)	Update config with a dictionary
`setup_maps_from_raster`(raster_fn[, ...])	This component adds data variable(s) from `raster_fn` to maps object.
`setup_maps_from_raster_reclass`(raster_fn, ...)	This component adds data variable(s) to maps object by reclassifying the data in `raster_fn` based on `reclass_table_fn`.
`setup_region`(region[, hydrography_fn, ...])	This component sets the region of interest of the model.
`test_model_api`()
`update`([model_out, write, opt])	Single method to update a model based the settings in opt.
`write`([components])	Write the complete model schematization and configuration to model files.
`write_config`([config_name, config_root])	Write config to <root/config_fn>
`write_data_catalog`([root, data_lib_fn, ...])	Write the data catalog to data_lib_fn
`write_forcing`([fn])	Write forcing to netcdf file at <root>/<fn>
`write_geoms`([fn])	Write model geometries to a vector file (by default GeoJSON) at <root>/<fn>
`write_grid`([fn])	Write model grid data to netcdf file at <root>/<fn>
`write_maps`([fn])	Write maps to netcdf file at <root>/<fn>
`write_states`([fn])	Write states to netcdf file at <root>/<fn>
`write_staticgeoms`()	This method will be deprecated in future versions, use `write_geoms()`
`write_staticmaps`([fn])	Write static model maps to netcdf file at <root>/<fn>

Attributes

`api`	Return all model components and their data types
`bounds`	Returns the bounding box of the model grid.
`config`	Model configuration.
`coords`	Returns the coordinates of model staticmaps.
`crs`	Returns coordinate reference system embedded in the model grid.
`dims`	Returns spatial dimension names of staticmaps.
`forcing`	Model forcing.
`geoms`	Model geometries.
`grid`	Model static gridded data.
`height`	Returns the height of the model staticmaps.
`maps`	Model maps.
`region`	Returns the geometry of the model area of interest.
`res`	Returns the resolution of the model grid.
`results`	Model results.
`root`	Path to model folder.
`shape`	Returns the shape of the model staticmaps.
`states`	Model states.
`staticgeoms`	This property will be deprecated in future versions, use `geom()`
`staticmaps`	Model static maps.
`transform`	Returns spatial transform of the model grid.
`width`	Returns the width of the model staticmaps.