hydromt_wflow.components.WflowStaticmapsComponent#
- class hydromt_wflow.components.WflowStaticmapsComponent(model: Model, *, filename: str = 'staticmaps.nc', region_filename: str = 'staticgeoms/region.geojson')[source]#
Wflow staticmaps component.
Inherits from the HydroMT-core GridComponent model-component. It is used for setting, creating, writing, and reading static and cyclic data for a Wflow model on a regular grid. The component data, stored in the
dataproperty of this class, is of the hydromt.gis.raster.RasterDataset type which is an extension of xarray.Dataset for regular grid.Initialize a WflowStaticmapsComponent.
- Parameters:
- __init__(model: Model, *, filename: str = 'staticmaps.nc', region_filename: str = 'staticgeoms/region.geojson')[source]#
Initialize a WflowStaticmapsComponent.
- Parameters:
Methods
__init__(model, *[, filename, region_filename])Initialize a WflowStaticmapsComponent.
clip(region[, inverse_clip, crs, ...])Clip staticmaps to region.
close()Clean up all open datasets.
drop_vars(names[, errors])Drop variables from the grid.
finish_write()Finish the write functionality after cleanup was called for all components in the model.
get_mask_layer(mask, *args)Get the proper mask layer based on itself or a layer in a Dataset.
read(**kwargs)Read staticmaps model data.
set(data[, name])Add data to the staticmaps.
test_equal(other)Test if two staticmaps components are equal.
update_names(**rename)Map the names of the data variables to new ones.
write([filename])Write staticmaps model data.
write_region([filename, to_wgs84])Write the model region to file.
Attributes
boundsReturns the bounding box of the model grid.
crsReturns coordinate reference system embedded in the model grid.
Model static gridded data as xarray.Dataset.
data_catalogReturn the data catalog of the model this component is associated with.
modelReturn the model object this component is associated with.
name_in_modelFind the name of the component in the parent model components.
regionProvide access to the underlying GeoDataFrame data of the model region.
resReturns the resolution of the model grid.
rootReturn the root of the model this component is associated with.
transformReturns spatial transform of the model grid.