Skip to main content
Back to top
Ctrl
+
K
HydroMT Core
Getting started
User guide
Plugins
API reference
More
What’s new
Search
Ctrl
+
K
Choose version
Search
Ctrl
+
K
Getting started
User guide
Plugins
API reference
What’s new
Choose version
Section Navigation
Command Line Interface
DataAdapter
hydromt.data_catalog.adapters.data_adapter_base.DataAdapterBase
hydromt.data_catalog.adapters.RasterDatasetAdapter
hydromt.data_catalog.adapters.RasterDatasetAdapter.transform
hydromt.data_catalog.adapters.GeoDatasetAdapter
hydromt.data_catalog.adapters.GeoDatasetAdapter.transform
hydromt.data_catalog.adapters.GeoDataFrameAdapter
hydromt.data_catalog.adapters.GeoDataFrameAdapter.transform
hydromt.data_catalog.adapters.DataFrameAdapter
hydromt.data_catalog.adapters.DataFrameAdapter.transform
hydromt.data_catalog.adapters.DatasetAdapter
hydromt.data_catalog.adapters.DatasetAdapter.transform
Data catalog
hydromt.data_catalog.DataCatalog
hydromt.data_catalog.DataCatalog.get_source
hydromt.data_catalog.DataCatalog.sources
hydromt.data_catalog.DataCatalog.predefined_catalogs
hydromt.data_catalog.DataCatalog.to_dict
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_yml
hydromt.data_catalog.DataCatalog.from_dict
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
Data sources
hydromt.data_catalog.sources.DataSource
hydromt.data_catalog.sources.DataSource.summary
hydromt.data_catalog.sources.RasterDatasetSource
hydromt.data_catalog.sources.RasterDatasetSource.read_data
hydromt.data_catalog.sources.RasterDatasetSource.to_stac_catalog
hydromt.data_catalog.sources.RasterDatasetSource.get_bbox
hydromt.data_catalog.sources.RasterDatasetSource.get_time_range
hydromt.data_catalog.sources.RasterDatasetSource.detect_bbox
hydromt.data_catalog.sources.RasterDatasetSource.detect_time_range
hydromt.data_catalog.sources.GeoDataFrameSource
hydromt.data_catalog.sources.GeoDataFrameSource.read_data
hydromt.data_catalog.sources.GeoDataFrameSource.to_stac_catalog
hydromt.data_catalog.sources.GeoDataFrameSource.get_bbox
hydromt.data_catalog.sources.GeoDataFrameSource.detect_bbox
hydromt.data_catalog.sources.DataFrameSource
hydromt.data_catalog.sources.DataFrameSource.read_data
hydromt.data_catalog.sources.DataFrameSource.to_stac_catalog
hydromt.data_catalog.sources.GeoDatasetSource
hydromt.data_catalog.sources.GeoDatasetSource.read_data
hydromt.data_catalog.sources.GeoDatasetSource.to_stac_catalog
hydromt.data_catalog.sources.GeoDatasetSource.get_bbox
hydromt.data_catalog.sources.GeoDatasetSource.detect_bbox
Drivers
hydromt.data_catalog.drivers.BaseDriver
hydromt.data_catalog.drivers.RasterDatasetDriver
hydromt.data_catalog.drivers.RasterDatasetDriver.read
hydromt.data_catalog.drivers.RasterDatasetDriver.write
hydromt.data_catalog.drivers.RasterDatasetXarrayDriver
hydromt.data_catalog.drivers.RasterDatasetXarrayDriver.read
hydromt.data_catalog.drivers.RasterDatasetXarrayDriver.write
hydromt.data_catalog.drivers.RasterioDriver
hydromt.data_catalog.drivers.RasterioDriver.read
hydromt.data_catalog.drivers.RasterioDriver.write
hydromt.data_catalog.drivers.GeoDataFrameDriver
hydromt.data_catalog.drivers.GeoDataFrameDriver.read
hydromt.data_catalog.drivers.GeoDataFrameDriver.write
hydromt.data_catalog.drivers.PyogrioDriver
hydromt.data_catalog.drivers.PyogrioDriver.read
hydromt.data_catalog.drivers.PyogrioDriver.write
hydromt.data_catalog.drivers.GeoDataFrameTableDriver
hydromt.data_catalog.drivers.GeoDataFrameTableDriver.read
hydromt.data_catalog.drivers.GeoDataFrameTableDriver.write
hydromt.data_catalog.drivers.DataFrameDriver
hydromt.data_catalog.drivers.DataFrameDriver.read
hydromt.data_catalog.drivers.DataFrameDriver.write
hydromt.data_catalog.drivers.PandasDriver
hydromt.data_catalog.drivers.PandasDriver.read
hydromt.data_catalog.drivers.PandasDriver.write
hydromt.data_catalog.drivers.GeoDatasetDriver
hydromt.data_catalog.drivers.GeoDatasetDriver.read
hydromt.data_catalog.drivers.GeoDatasetDriver.write
hydromt.data_catalog.drivers.GeoDatasetXarrayDriver
hydromt.data_catalog.drivers.GeoDatasetXarrayDriver.read
hydromt.data_catalog.drivers.GeoDatasetXarrayDriver.write
hydromt.data_catalog.drivers.GeoDatasetVectorDriver
hydromt.data_catalog.drivers.GeoDatasetVectorDriver.read
hydromt.data_catalog.drivers.GeoDatasetVectorDriver.write
hydromt.data_catalog.drivers.DatasetDriver
hydromt.data_catalog.drivers.DatasetDriver.read
hydromt.data_catalog.drivers.DatasetDriver.write
hydromt.data_catalog.drivers.DatasetXarrayDriver
hydromt.data_catalog.drivers.DatasetXarrayDriver.read
hydromt.data_catalog.drivers.DatasetXarrayDriver.write
GIS methods
hydromt.gis.raster.full
hydromt.gis.raster.full_like
hydromt.gis.raster.full_from_transform
hydromt.gis.raster_merge.merge
hydromt.gis.DataArray.raster.from_numpy
hydromt.gis.Dataset.raster.from_numpy
hydromt.gis.DataArray.raster.attrs
hydromt.gis.DataArray.raster.crs
hydromt.gis.DataArray.raster.bounds
hydromt.gis.DataArray.raster.transform
hydromt.gis.DataArray.raster.res
hydromt.gis.DataArray.raster.rotation
hydromt.gis.DataArray.raster.origin
hydromt.gis.DataArray.raster.nodata
hydromt.gis.DataArray.raster.dims
hydromt.gis.DataArray.raster.coords
hydromt.gis.DataArray.raster.dim0
hydromt.gis.DataArray.raster.y_dim
hydromt.gis.DataArray.raster.x_dim
hydromt.gis.DataArray.raster.xcoords
hydromt.gis.DataArray.raster.ycoords
hydromt.gis.DataArray.raster.shape
hydromt.gis.DataArray.raster.size
hydromt.gis.DataArray.raster.width
hydromt.gis.DataArray.raster.height
hydromt.gis.DataArray.raster.internal_bounds
hydromt.gis.DataArray.raster.box
hydromt.gis.DataArray.raster.set_crs
hydromt.gis.DataArray.raster.set_spatial_dims
hydromt.gis.DataArray.raster.reset_spatial_dims_attrs
hydromt.gis.DataArray.raster.identical_grid
hydromt.gis.DataArray.raster.aligned_grid
hydromt.gis.DataArray.raster.gdal_compliant
hydromt.gis.DataArray.raster.idx_to_xy
hydromt.gis.DataArray.raster.xy_to_idx
hydromt.gis.DataArray.raster.rowcol
hydromt.gis.DataArray.raster.xy
hydromt.gis.DataArray.raster.flipud
hydromt.gis.DataArray.raster.area_grid
hydromt.gis.DataArray.raster.density_grid
hydromt.gis.DataArray.raster.reclassify
hydromt.gis.DataArray.raster.set_nodata
hydromt.gis.DataArray.raster.mask_nodata
hydromt.gis.DataArray.raster.interpolate_na
hydromt.gis.DataArray.raster.clip
hydromt.gis.DataArray.raster.clip_bbox
hydromt.gis.DataArray.raster.clip_mask
hydromt.gis.DataArray.raster.clip_geom
hydromt.gis.DataArray.raster.reproject
hydromt.gis.DataArray.raster.reindex2d
hydromt.gis.DataArray.raster.reproject_like
hydromt.gis.DataArray.raster.transform_bounds
hydromt.gis.DataArray.raster.nearest_index
hydromt.gis.DataArray.raster.rasterize
hydromt.gis.DataArray.raster.rasterize_geometry
hydromt.gis.DataArray.raster.geometry_mask
hydromt.gis.DataArray.raster.vectorize
hydromt.gis.DataArray.raster.vector_grid
hydromt.gis.DataArray.raster.sample
hydromt.gis.DataArray.raster.zonal_stats
hydromt.gis.DataArray.raster.to_xyz_tiles
hydromt.gis.DataArray.raster.to_slippy_tiles
hydromt.gis.DataArray.raster.to_raster
hydromt.gis.Dataset.raster.to_mapstack
hydromt.gis.DataArray.vector.from_gdf
hydromt.gis.DataArray.vector.to_gdf
hydromt.gis.DataArray.vector.from_netcdf
hydromt.gis.DataArray.vector.to_netcdf
hydromt.gis.Dataset.vector.from_gdf
hydromt.gis.Dataset.vector.to_gdf
hydromt.gis.Dataset.vector.from_netcdf
hydromt.gis.Dataset.vector.to_netcdf
hydromt.gis.DataArray.vector.attrs
hydromt.gis.DataArray.vector.crs
hydromt.gis.DataArray.vector.index_dim
hydromt.gis.DataArray.vector.time_dim
hydromt.gis.DataArray.vector.x_name
hydromt.gis.DataArray.vector.y_name
hydromt.gis.DataArray.vector.geom_name
hydromt.gis.DataArray.vector.geom_type
hydromt.gis.DataArray.vector.geom_format
hydromt.gis.DataArray.vector.index
hydromt.gis.DataArray.vector.bounds
hydromt.gis.DataArray.vector.size
hydromt.gis.DataArray.vector.sindex
hydromt.gis.DataArray.vector.geometry
hydromt.gis.Dataset.vector.attrs
hydromt.gis.Dataset.vector.crs
hydromt.gis.Dataset.vector.index_dim
hydromt.gis.Dataset.vector.time_dim
hydromt.gis.Dataset.vector.x_name
hydromt.gis.Dataset.vector.y_name
hydromt.gis.Dataset.vector.geom_name
hydromt.gis.Dataset.vector.geom_type
hydromt.gis.Dataset.vector.geom_format
hydromt.gis.Dataset.vector.index
hydromt.gis.Dataset.vector.bounds
hydromt.gis.Dataset.vector.size
hydromt.gis.Dataset.vector.sindex
hydromt.gis.Dataset.vector.geometry
hydromt.gis.DataArray.vector.ogr_compliant
hydromt.gis.DataArray.vector.update_geometry
hydromt.gis.DataArray.vector.to_geom
hydromt.gis.DataArray.vector.to_xy
hydromt.gis.DataArray.vector.to_wkt
hydromt.gis.Dataset.vector.ogr_compliant
hydromt.gis.Dataset.vector.update_geometry
hydromt.gis.Dataset.vector.to_geom
hydromt.gis.Dataset.vector.to_xy
hydromt.gis.Dataset.vector.to_wkt
hydromt.gis.DataArray.vector.set_crs
hydromt.gis.DataArray.vector.set_spatial_dims
hydromt.gis.Dataset.vector.set_crs
hydromt.gis.Dataset.vector.set_spatial_dims
hydromt.gis.DataArray.vector.clip_bbox
hydromt.gis.DataArray.vector.clip_geom
hydromt.gis.Dataset.vector.clip_bbox
hydromt.gis.Dataset.vector.clip_geom
hydromt.gis.DataArray.vector.to_crs
hydromt.gis.Dataset.vector.to_crs
hydromt.gis.flw.flwdir_from_da
hydromt.gis.flw.d8_from_dem
hydromt.gis.flw.reproject_hydrography_like
hydromt.gis.flw.upscale_flwdir
hydromt.gis.flw.stream_map
hydromt.gis.flw.basin_map
hydromt.gis.flw.gauge_map
hydromt.gis.flw.outlet_map
hydromt.gis.flw.clip_basins
hydromt.gis.flw.dem_adjust
Model
hydromt.model.Model
hydromt.model.Model.read
hydromt.model.Model.write
hydromt.model.Model.write_data_catalog
hydromt.model.Model.build
hydromt.model.Model.update
hydromt.model.Model.get_component
hydromt.model.Model.add_component
hydromt.model.Model.test_equal
hydromt.model.Model.data_catalog
hydromt.model.Model.crs
hydromt.model.Model.root
hydromt.model.Model.region
hydromt.model.Model.components
hydromt.model.ModelRoot
hydromt.model.ModelRoot.mode
hydromt.model.ModelRoot.is_writing_mode
hydromt.model.ModelRoot.is_reading_mode
hydromt.model.ModelRoot.is_override_mode
hydromt.model.ModelRoot.set
hydromt.model.components.ModelComponent
hydromt.model.components.ModelComponent.model
hydromt.model.components.ModelComponent.data_catalog
hydromt.model.components.ModelComponent.read
hydromt.model.components.ModelComponent.write
hydromt.model.components.ModelComponent.root
hydromt.model.components.SpatialModelComponent
hydromt.model.components.SpatialModelComponent.model
hydromt.model.components.SpatialModelComponent.data_catalog
hydromt.model.components.SpatialModelComponent.root
hydromt.model.components.SpatialModelComponent.crs
hydromt.model.components.SpatialModelComponent.bounds
hydromt.model.components.SpatialModelComponent.region
hydromt.model.components.SpatialModelComponent._region_data
hydromt.model.components.SpatialModelComponent.write_region
hydromt.model.components.SpatialModelComponent.test_equal
hydromt.model.components.ConfigComponent
hydromt.model.components.ConfigComponent.model
hydromt.model.components.ConfigComponent.data_catalog
hydromt.model.components.ConfigComponent.root
hydromt.model.components.ConfigComponent.data
hydromt.model.components.ConfigComponent.write
hydromt.model.components.ConfigComponent.read
hydromt.model.components.ConfigComponent.create
hydromt.model.components.ConfigComponent.update
hydromt.model.components.ConfigComponent.set
hydromt.model.components.ConfigComponent.get_value
hydromt.model.components.ConfigComponent.test_equal
hydromt.model.components.GeomsComponent
hydromt.model.components.GeomsComponent.model
hydromt.model.components.GeomsComponent.data_catalog
hydromt.model.components.GeomsComponent.root
hydromt.model.components.GeomsComponent.data
hydromt.model.components.GeomsComponent.region
hydromt.model.components.GeomsComponent.write
hydromt.model.components.GeomsComponent.read
hydromt.model.components.GeomsComponent.set
hydromt.model.components.GeomsComponent.test_equal
hydromt.model.components.TablesComponent
hydromt.model.components.TablesComponent.model
hydromt.model.components.TablesComponent.data_catalog
hydromt.model.components.TablesComponent.root
hydromt.model.components.TablesComponent.data
hydromt.model.components.TablesComponent.write
hydromt.model.components.TablesComponent.read
hydromt.model.components.TablesComponent.set
hydromt.model.components.TablesComponent.test_equal
hydromt.model.components.DatasetsComponent
hydromt.model.components.DatasetsComponent.model
hydromt.model.components.DatasetsComponent.data_catalog
hydromt.model.components.DatasetsComponent.root
hydromt.model.components.DatasetsComponent.data
hydromt.model.components.DatasetsComponent.write
hydromt.model.components.DatasetsComponent.read
hydromt.model.components.DatasetsComponent.set
hydromt.model.components.DatasetsComponent.test_equal
hydromt.model.components.SpatialDatasetsComponent
hydromt.model.components.SpatialDatasetsComponent.model
hydromt.model.components.SpatialDatasetsComponent.data_catalog
hydromt.model.components.SpatialDatasetsComponent.root
hydromt.model.components.SpatialDatasetsComponent.data
hydromt.model.components.SpatialDatasetsComponent.region
hydromt.model.components.SpatialDatasetsComponent.write
hydromt.model.components.SpatialDatasetsComponent.read
hydromt.model.components.SpatialDatasetsComponent.add_raster_data_from_raster_reclass
hydromt.model.components.SpatialDatasetsComponent.add_raster_data_from_rasterdataset
hydromt.model.components.SpatialDatasetsComponent.set
hydromt.model.components.SpatialDatasetsComponent.test_equal
hydromt.model.components.GridComponent
hydromt.model.components.GridComponent.model
hydromt.model.components.GridComponent.data_catalog
hydromt.model.components.GridComponent.root
hydromt.model.components.GridComponent.res
hydromt.model.components.GridComponent.transform
hydromt.model.components.GridComponent.crs
hydromt.model.components.GridComponent.bounds
hydromt.model.components.GridComponent.region
hydromt.model.components.GridComponent.data
hydromt.model.components.GridComponent.write
hydromt.model.components.GridComponent.read
hydromt.model.components.GridComponent.create_from_region
hydromt.model.components.GridComponent.add_data_from_constant
hydromt.model.components.GridComponent.add_data_from_rasterdataset
hydromt.model.components.GridComponent.add_data_from_raster_reclass
hydromt.model.components.GridComponent.add_data_from_geodataframe
hydromt.model.components.GridComponent.set
hydromt.model.components.GridComponent.test_equal
hydromt.model.components.MeshComponent
hydromt.model.components.MeshComponent.model
hydromt.model.components.MeshComponent.data_catalog
hydromt.model.components.MeshComponent.root
hydromt.model.components.MeshComponent.data
hydromt.model.components.MeshComponent.crs
hydromt.model.components.MeshComponent.bounds
hydromt.model.components.MeshComponent.region
hydromt.model.components.MeshComponent.mesh_names
hydromt.model.components.MeshComponent.mesh_grids
hydromt.model.components.MeshComponent.mesh_datasets
hydromt.model.components.MeshComponent.mesh_gdf
hydromt.model.components.MeshComponent.write
hydromt.model.components.MeshComponent.read
hydromt.model.components.MeshComponent.create_2d_from_region
hydromt.model.components.MeshComponent.add_2d_data_from_rasterdataset
hydromt.model.components.MeshComponent.add_2d_data_from_raster_reclass
hydromt.model.components.MeshComponent.set
hydromt.model.components.MeshComponent.get_mesh
hydromt.model.components.VectorComponent
hydromt.model.components.VectorComponent.data
hydromt.model.components.VectorComponent.geometry
hydromt.model.components.VectorComponent.index_dim
hydromt.model.components.VectorComponent.crs
hydromt.model.components.VectorComponent.model
hydromt.model.components.VectorComponent.data_catalog
hydromt.model.components.VectorComponent.root
hydromt.model.components.VectorComponent.read
hydromt.model.components.VectorComponent.write
hydromt.model.components.VectorComponent.set
hydromt.model.components.VectorComponent.test_equal
hydromt.model.processes.grid.create_grid_from_region
hydromt.model.processes.grid.create_rotated_grid_from_geom
hydromt.model.processes.grid.grid_from_constant
hydromt.model.processes.grid.grid_from_rasterdataset
hydromt.model.processes.grid.grid_from_raster_reclass
hydromt.model.processes.grid.grid_from_geodataframe
hydromt.model.processes.grid.rotated_grid
hydromt.model.processes.mesh.create_mesh2d_from_region
hydromt.model.processes.mesh.create_mesh2d_from_mesh
hydromt.model.processes.mesh.create_mesh2d_from_geom
hydromt.model.processes.mesh.mesh2d_from_rasterdataset
hydromt.model.processes.mesh.mesh2d_from_raster_reclass
hydromt.model.processes.region.parse_region_basin
hydromt.model.processes.region.parse_region_bbox
hydromt.model.processes.region.parse_region_geom
hydromt.model.processes.region.parse_region_grid
hydromt.model.processes.region.parse_region_other_model
hydromt.model.processes.region.parse_region_mesh
hydromt.model.processes.basin_mask.get_basin_geometry
hydromt.model.processes.rivers.river_width
hydromt.model.processes.rivers.river_depth
hydromt.model.processes.meteo.precip
hydromt.model.processes.meteo.temp
hydromt.model.processes.meteo.press
hydromt.model.processes.meteo.pet
hydromt.model.processes.meteo.wind
hydromt.model.processes.meteo.press_correction
hydromt.model.processes.meteo.temp_correction
hydromt.model.processes.meteo.resample_time
hydromt.model.processes.meteo.delta_freq
hydromt.model.processes.meteo.pet_debruin
hydromt.model.processes.meteo.pet_makkink
hydromt.model.processes.meteo.pm_fao56
Statistics and Extreme Value Analysis
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
Plugins
hydromt.plugins.Plugins
hydromt.plugins.Plugins.plugin_summary
hydromt.plugins.Plugins.model_plugins
hydromt.plugins.Plugins.model_metadata
hydromt.plugins.Plugins.model_summary
hydromt.plugins.Plugins.component_plugins
hydromt.plugins.Plugins.component_metadata
hydromt.plugins.Plugins.component_summary
hydromt.plugins.Plugins.driver_plugins
hydromt.plugins.Plugins.driver_metadata
hydromt.plugins.Plugins.driver_summary
hydromt.plugins.Plugins.catalog_plugins
hydromt.plugins.Plugins.catalog_metadata
hydromt.plugins.Plugins.catalog_summary
Utility functions
URIResolver
hydromt.data_catalog.uri_resolvers.URIResolver
hydromt.data_catalog.uri_resolvers.URIResolver.resolve
hydromt.data_catalog.uri_resolvers.ConventionResolver
hydromt.data_catalog.uri_resolvers.ConventionResolver.resolve
hydromt.data_catalog.uri_resolvers.RasterTindexResolver
hydromt.data_catalog.uri_resolvers.RasterTindexResolver.resolve
API reference
Plugins
hydromt.plugins.Plugins.plugin_summary
hydromt.plugins.Plugins.plugin_summary
#
Plugins.
plugin_summary
(
)
→
str
[source]
#
On this page
Plugins.plugin_summary()
Edit on GitHub
Show Source
