Skip to main content

Ctrl+K

HydroMT Core

Getting started
User guide
API reference
Dev guide
Plugins

Getting started
User guide
API reference
Dev guide
Plugins

Section Navigation

hydromt
hydromt build
hydromt update
hydromt clip
hydromt export
hydromt check

hydromt.data_catalog.DataCatalog
hydromt.data_catalog.DataCatalog.get_source
hydromt.data_catalog.DataCatalog.iter_sources
hydromt.data_catalog.DataCatalog.sources
hydromt.data_catalog.DataCatalog.keys
hydromt.data_catalog.DataCatalog.predefined_catalogs
hydromt.data_catalog.DataCatalog.to_dict
hydromt.data_catalog.DataCatalog.to_dataframe
hydromt.data_catalog.DataCatalog.to_yml
hydromt.data_catalog.DataCatalog.export_data
hydromt.data_catalog.DataCatalog.get_source_bbox
hydromt.data_catalog.DataCatalog.get_source_time_range

hydromt.data_catalog.DataCatalog.add_source
hydromt.data_catalog.DataCatalog.update
hydromt.data_catalog.DataCatalog.from_predefined_catalogs
hydromt.data_catalog.DataCatalog.from_archive
hydromt.data_catalog.DataCatalog.from_yml
hydromt.data_catalog.DataCatalog.from_dict
hydromt.data_catalog.DataCatalog.set_predefined_catalogs

hydromt.data_catalog.DataCatalog.get_rasterdataset
hydromt.data_catalog.DataCatalog.get_geodataset
hydromt.data_catalog.DataCatalog.get_geodataframe
hydromt.data_catalog.DataCatalog.get_dataframe
hydromt.data_catalog.DataCatalog.get_dataset

hydromt.data_adapter.DataAdapter
hydromt.data_adapter.DataAdapter.summary
hydromt.data_adapter.DataAdapter.to_dict

hydromt.data_adapter.RasterDatasetAdapter
hydromt.data_adapter.RasterDatasetAdapter.summary
hydromt.data_adapter.RasterDatasetAdapter.get_data
hydromt.data_adapter.RasterDatasetAdapter.to_dict
hydromt.data_adapter.RasterDatasetAdapter.to_file
hydromt.data_adapter.RasterDatasetAdapter.get_bbox
hydromt.data_adapter.RasterDatasetAdapter.get_time_range
hydromt.data_adapter.RasterDatasetAdapter.detect_bbox
hydromt.data_adapter.RasterDatasetAdapter.detect_time_range
hydromt.data_adapter.RasterDatasetAdapter.to_stac_catalog

hydromt.data_adapter.GeoDatasetAdapter
hydromt.data_adapter.GeoDatasetAdapter.summary
hydromt.data_adapter.GeoDatasetAdapter.get_data
hydromt.data_adapter.GeoDatasetAdapter.to_dict
hydromt.data_adapter.GeoDatasetAdapter.to_file
hydromt.data_adapter.GeoDatasetAdapter.get_bbox
hydromt.data_adapter.GeoDatasetAdapter.get_time_range
hydromt.data_adapter.GeoDatasetAdapter.detect_bbox
hydromt.data_adapter.GeoDatasetAdapter.detect_time_range
hydromt.data_adapter.GeoDatasetAdapter.to_stac_catalog

hydromt.data_adapter.GeoDataFrameAdapter
hydromt.data_adapter.GeoDataFrameAdapter.summary
hydromt.data_adapter.GeoDataFrameAdapter.get_data
hydromt.data_adapter.GeoDataFrameAdapter.to_dict
hydromt.data_adapter.GeoDataFrameAdapter.to_file
hydromt.data_adapter.GeoDataFrameAdapter.get_bbox
hydromt.data_adapter.GeoDataFrameAdapter.detect_bbox
hydromt.data_adapter.GeoDataFrameAdapter.to_stac_catalog

hydromt.data_adapter.DataFrameAdapter
hydromt.data_adapter.DataFrameAdapter.summary
hydromt.data_adapter.DataFrameAdapter.get_data
hydromt.data_adapter.DataFrameAdapter.to_dict
hydromt.data_adapter.DataFrameAdapter.to_file
hydromt.data_adapter.DataFrameAdapter.to_stac_catalog

hydromt.data_adapter.DatasetAdapter
hydromt.data_adapter.DatasetAdapter.summary
hydromt.data_adapter.DatasetAdapter.get_data
hydromt.data_adapter.DatasetAdapter.to_dict
hydromt.data_adapter.DatasetAdapter.to_file
hydromt.data_adapter.DatasetAdapter.to_stac_catalog

hydromt.ModelCatalog

hydromt.Model

hydromt.Model.read
hydromt.Model.write
hydromt.Model.build
hydromt.Model.update
hydromt.Model.set_root
hydromt.Model.write_data_catalog

hydromt.Model.crs
hydromt.Model.region
hydromt.Model.root
hydromt.Model.api

hydromt.Model.config
hydromt.Model.maps
hydromt.Model.geoms
hydromt.Model.forcing
hydromt.Model.states
hydromt.Model.results

hydromt.Model.get_config
hydromt.Model.set_config
hydromt.Model.read_config
hydromt.Model.write_config
hydromt.Model.set_maps
hydromt.Model.read_maps
hydromt.Model.write_maps
hydromt.Model.set_geoms
hydromt.Model.read_geoms
hydromt.Model.write_geoms
hydromt.Model.set_forcing
hydromt.Model.read_forcing
hydromt.Model.write_forcing
hydromt.Model.set_states
hydromt.Model.read_states
hydromt.Model.write_states
hydromt.Model.set_results
hydromt.Model.read_results
hydromt.Model.read_nc
hydromt.Model.write_nc

hydromt.Model.setup_config
hydromt.Model.setup_region
hydromt.Model.setup_maps_from_rasterdataset
hydromt.Model.setup_maps_from_raster_reclass

hydromt.GridModel

hydromt.GridModel.grid
hydromt.GridModel.crs
hydromt.GridModel.region

hydromt.GridModel.set_grid
hydromt.GridModel.read_grid
hydromt.GridModel.write_grid

hydromt.GridModel.setup_config
hydromt.GridModel.setup_region
hydromt.GridModel.setup_maps_from_rasterdataset
hydromt.GridModel.setup_maps_from_raster_reclass
hydromt.GridModel.setup_grid
hydromt.GridModel.setup_grid_from_constant
hydromt.GridModel.setup_grid_from_rasterdataset
hydromt.GridModel.setup_grid_from_raster_reclass
hydromt.GridModel.setup_grid_from_geodataframe

hydromt.VectorModel

hydromt.VectorModel.vector
hydromt.VectorModel.crs
hydromt.VectorModel.region

hydromt.VectorModel.set_vector
hydromt.VectorModel.read_vector
hydromt.VectorModel.write_vector

hydromt.VectorModel.setup_config
hydromt.VectorModel.setup_region
hydromt.VectorModel.setup_maps_from_rasterdataset
hydromt.VectorModel.setup_maps_from_raster_reclass

hydromt.MeshModel

hydromt.MeshModel.mesh
hydromt.MeshModel.mesh_names
hydromt.MeshModel.mesh_grids
hydromt.MeshModel.mesh_datasets
hydromt.MeshModel.mesh_gdf
hydromt.MeshModel.crs
hydromt.MeshModel.region
hydromt.MeshModel.bounds

hydromt.MeshModel.set_mesh
hydromt.MeshModel.get_mesh
hydromt.MeshModel.read_mesh
hydromt.MeshModel.write_mesh

hydromt.MeshModel.setup_config
hydromt.MeshModel.setup_region
hydromt.MeshModel.setup_mesh2d
hydromt.MeshModel.setup_mesh2d_from_rasterdataset
hydromt.MeshModel.setup_mesh2d_from_raster_reclass
hydromt.MeshModel.setup_maps_from_rasterdataset
hydromt.MeshModel.setup_maps_from_raster_reclass

hydromt.workflows.grid.grid_from_constant
hydromt.workflows.grid.grid_from_rasterdataset
hydromt.workflows.grid.grid_from_raster_reclass
hydromt.workflows.grid.grid_from_geodataframe

hydromt.workflows.mesh.create_mesh2d
hydromt.workflows.mesh.mesh2d_from_rasterdataset
hydromt.workflows.mesh.mesh2d_from_raster_reclass

hydromt.workflows.basin_mask.get_basin_geometry
hydromt.workflows.basin_mask.parse_region

hydromt.workflows.rivers.river_width
hydromt.workflows.rivers.river_depth

hydromt.workflows.forcing.precip
hydromt.workflows.forcing.temp
hydromt.workflows.forcing.press
hydromt.workflows.forcing.pet
hydromt.workflows.forcing.wind

hydromt.workflows.forcing.press_correction
hydromt.workflows.forcing.temp_correction

hydromt.workflows.forcing.resample_time
hydromt.workflows.forcing.delta_freq

hydromt.workflows.forcing.pet_debruin
hydromt.workflows.forcing.pet_makkink
hydromt.workflows.forcing.pm_fao56

hydromt.io.open_raster
hydromt.io.open_mfraster
hydromt.io.open_raster_from_tindex
hydromt.io.open_vector
hydromt.io.open_vector_from_table
hydromt.io.open_geodataset
hydromt.io.open_timeseries_from_table

hydromt.DataArray.raster.to_xyz_tiles
hydromt.DataArray.raster.to_slippy_tiles
hydromt.DataArray.raster.to_raster
hydromt.Dataset.raster.to_mapstack

hydromt.merge.merge
hydromt.raster.full
hydromt.raster.full_like
hydromt.raster.full_from_transform

hydromt.DataArray.raster.from_numpy
hydromt.Dataset.raster.from_numpy

hydromt.DataArray.raster.attrs
hydromt.DataArray.raster.crs
hydromt.DataArray.raster.bounds
hydromt.DataArray.raster.transform
hydromt.DataArray.raster.res
hydromt.DataArray.raster.rotation
hydromt.DataArray.raster.origin
hydromt.DataArray.raster.nodata
hydromt.DataArray.raster.dims
hydromt.DataArray.raster.coords
hydromt.DataArray.raster.dim0
hydromt.DataArray.raster.y_dim
hydromt.DataArray.raster.x_dim
hydromt.DataArray.raster.xcoords
hydromt.DataArray.raster.ycoords
hydromt.DataArray.raster.shape
hydromt.DataArray.raster.size
hydromt.DataArray.raster.width
hydromt.DataArray.raster.height
hydromt.DataArray.raster.internal_bounds
hydromt.DataArray.raster.box

hydromt.DataArray.raster.set_crs
hydromt.DataArray.raster.set_spatial_dims
hydromt.DataArray.raster.reset_spatial_dims_attrs
hydromt.DataArray.raster.identical_grid
hydromt.DataArray.raster.aligned_grid
hydromt.DataArray.raster.gdal_compliant
hydromt.DataArray.raster.idx_to_xy
hydromt.DataArray.raster.xy_to_idx
hydromt.DataArray.raster.rowcol
hydromt.DataArray.raster.xy
hydromt.DataArray.raster.flipud
hydromt.DataArray.raster.area_grid
hydromt.DataArray.raster.density_grid
hydromt.DataArray.raster.reclassify

hydromt.DataArray.raster.set_nodata
hydromt.DataArray.raster.mask_nodata
hydromt.DataArray.raster.interpolate_na

hydromt.DataArray.raster.clip
hydromt.DataArray.raster.clip_bbox
hydromt.DataArray.raster.clip_mask
hydromt.DataArray.raster.clip_geom

hydromt.DataArray.raster.reproject
hydromt.DataArray.raster.reindex2d
hydromt.DataArray.raster.reproject_like
hydromt.DataArray.raster.transform_bounds
hydromt.DataArray.raster.nearest_index

hydromt.DataArray.raster.rasterize
hydromt.DataArray.raster.rasterize_geometry
hydromt.DataArray.raster.geometry_mask
hydromt.DataArray.raster.vectorize
hydromt.DataArray.raster.vector_grid

hydromt.DataArray.raster.sample
hydromt.DataArray.raster.zonal_stats

hydromt.gis_utils.axes_attrs
hydromt.gis_utils.meridian_offset

hydromt.DataArray.vector.from_gdf
hydromt.DataArray.vector.to_gdf
hydromt.DataArray.vector.from_netcdf
hydromt.DataArray.vector.to_netcdf
hydromt.Dataset.vector.from_gdf
hydromt.Dataset.vector.to_gdf
hydromt.Dataset.vector.from_netcdf
hydromt.Dataset.vector.to_netcdf

hydromt.DataArray.vector.attrs
hydromt.DataArray.vector.crs
hydromt.DataArray.vector.index_dim
hydromt.DataArray.vector.time_dim
hydromt.DataArray.vector.x_name
hydromt.DataArray.vector.y_name
hydromt.DataArray.vector.geom_name
hydromt.DataArray.vector.geom_type
hydromt.DataArray.vector.geom_format
hydromt.DataArray.vector.index
hydromt.DataArray.vector.bounds
hydromt.DataArray.vector.size
hydromt.DataArray.vector.sindex
hydromt.DataArray.vector.geometry
hydromt.Dataset.vector.attrs
hydromt.Dataset.vector.crs
hydromt.Dataset.vector.index_dim
hydromt.Dataset.vector.time_dim
hydromt.Dataset.vector.x_name
hydromt.Dataset.vector.y_name
hydromt.Dataset.vector.geom_name
hydromt.Dataset.vector.geom_type
hydromt.Dataset.vector.geom_format
hydromt.Dataset.vector.index
hydromt.Dataset.vector.bounds
hydromt.Dataset.vector.size
hydromt.Dataset.vector.sindex
hydromt.Dataset.vector.geometry

hydromt.DataArray.vector.ogr_compliant
hydromt.DataArray.vector.update_geometry
hydromt.DataArray.vector.to_geom
hydromt.DataArray.vector.to_xy
hydromt.DataArray.vector.to_wkt
hydromt.Dataset.vector.ogr_compliant
hydromt.Dataset.vector.update_geometry
hydromt.Dataset.vector.to_geom
hydromt.Dataset.vector.to_xy
hydromt.Dataset.vector.to_wkt

hydromt.DataArray.vector.set_crs
hydromt.DataArray.vector.set_spatial_dims
hydromt.Dataset.vector.set_crs
hydromt.Dataset.vector.set_spatial_dims

hydromt.DataArray.vector.clip_bbox
hydromt.DataArray.vector.clip_geom
hydromt.Dataset.vector.clip_bbox
hydromt.Dataset.vector.clip_geom

hydromt.DataArray.vector.to_crs
hydromt.Dataset.vector.to_crs

hydromt.flw.flwdir_from_da
hydromt.flw.d8_from_dem
hydromt.flw.reproject_hydrography_like
hydromt.flw.upscale_flwdir
hydromt.flw.stream_map
hydromt.flw.basin_map
hydromt.flw.gauge_map
hydromt.flw.outlet_map
hydromt.flw.clip_basins
hydromt.flw.dem_adjust

hydromt.gis_utils.create_vrt
hydromt.gis_utils.spread2d
hydromt.gis_utils.reggrid_area
hydromt.gis_utils.cellarea
hydromt.gis_utils.cellres

hydromt.gis_utils.parse_crs
hydromt.gis_utils.utm_crs
hydromt.gis_utils.affine_to_coords

hydromt.gis_utils.filter_gdf
hydromt.gis_utils.nearest
hydromt.gis_utils.nearest_merge

hydromt.stats.skills.bias
hydromt.stats.skills.percentual_bias
hydromt.stats.skills.volumetric_error
hydromt.stats.skills.nashsutcliffe
hydromt.stats.skills.lognashsutcliffe
hydromt.stats.skills.pearson_correlation
hydromt.stats.skills.spearman_rank_correlation
hydromt.stats.skills.kge
hydromt.stats.skills.kge_2012
hydromt.stats.skills.kge_non_parametric
hydromt.stats.skills.kge_non_parametric_flood
hydromt.stats.skills.rsquared
hydromt.stats.skills.mse
hydromt.stats.skills.rmse
hydromt.stats.skills.rsr

hydromt.stats.extremes.get_peaks
hydromt.stats.extremes.fit_extremes
hydromt.stats.extremes.get_return_value
hydromt.stats.extremes.eva

hydromt.stats.design_events.get_peak_hydrographs

hydromt.config.configread
hydromt.config.configwrite

hydromt.log.setuplog

API reference
hydromt.Model.region

hydromt.Model.region#

property Model.region: GeoDataFrame#: Returns the geometry of the model area of interest.

previous

hydromt.Model.crs

next

hydromt.Model.root

On this page

Model.region

© Copyright Deltares.

Created using Sphinx 7.2.6.

Built with the PyData Sphinx Theme 0.15.2.