hydromt_sfincs.SfincsModel#
- class hydromt_sfincs.SfincsModel(root: str = None, mode: str = 'w', write_gis: bool = True, data_libs: List[str] | str = None, **catalog_keys)[source]#
SFINCS model class.
The SFINCS model class (SfincsModel) contains methods to read, write, setup and edit SFINCS models.
- Parameters:
root (
str,Path, optional) – Path to model foldermode (
{'w', 'r+', 'r'}) – Open model in write, append or reading mode, by default ‘w’write_gis (
bool) – Write model files additionally to geotiff and geojson, by default Truedata_libs (
List,str) – List of data catalog yaml files, by default None**catalog_keys – Additional keyword arguments to be passed down to the DataCatalog.
- __init__(root: str = None, mode: str = 'w', write_gis: bool = True, data_libs: List[str] | str = None, **catalog_keys)[source]#
The SFINCS model class (SfincsModel) contains methods to read, write, setup and edit SFINCS models.
- Parameters:
root (
str,Path, optional) – Path to model foldermode (
{'w', 'r+', 'r'}) – Open model in write, append or reading mode, by default ‘w’write_gis (
bool) – Write model files additionally to geotiff and geojson, by default Truedata_libs (
List,str) – List of data catalog yaml files, by default None**catalog_keys – Additional keyword arguments to be passed down to the DataCatalog.
Methods
__init__([root, mode, write_gis, data_libs])add_component(name, component)Add a component to the model.
build(*[, write])Single method to build a model from scratch based on settings in steps.
clear_spatial_components()Clear all spatial components.
close()Close all components by closing their open files.
from_dict(model_dict)Construct a model with the components and other init arguments in the yaml file located at path.
from_yml(path)Construct a model with the components and other init arguments in the yaml file located at path.
get_component(name)Get a component from the model.
get_model_time()Return (tstart, tstop) tuple with parsed model start and end time
plot_basemap([fn_out, variable, shaded, ...])Create basemap plot.
plot_forcing([fn_out, forcings])Plot model timeseries forcing.
read()Read SfincsModel from disk.
test_equal(other)Test if two models are equal, based on their components.
update(*[, model_out, write, steps, ...])Single method to update a model based the settings in steps.
write()Write SfincsModel to disk.
write_data_catalog([root, data_lib_path, ...])Write the data catalog to data_lib_path.
Attributes
Returns the bounding box in WGS 84 of the model grid.
boundsReturns the bounding box of the model grid.
configInstance of
SfincsConfig.cross_sectionsInstance of
SfincsCrossSections.Returns the model crs
discharge_pointsInstance of
SfincsDischargePoints.drainage_structuresInstance of
SfincsDrainageStructures.elevationInstance of
SfincsElevation.gridInstance of
SfincsGrid.infiltrationInstance of
SfincsInfiltration.initial_conditionsInstance of
SfincsInitialConditions.maskInstance of
SfincsMask.nameobservation_pointsInstance of
SfincsObservationPoints.outputInstance of
SfincsOutput.precipitationInstance of
SfincsPrecipitation.pressureInstance of
SfincsPressure.quadtree_elevationInstance of
SfincsQuadtreeElevation.quadtree_gridInstance of
SfincsQuadtreeGrid.quadtree_infiltrationInstance of
SfincsQuadtreeInfiltration.quadtree_initial_conditionsInstance of
SfincsQuadtreeInitialConditions.quadtree_maskInstance of
SfincsQuadtreeMask.quadtree_snapwave_maskInstance of
SnapWaveQuadtreeMask.quadtree_storage_volumeInstance of
SfincsQuadtreeStorageVolume.quadtree_subgridInstance of
SfincsQuadtreeSubgridTable.Returns the geometry of the active model cells.
riversInstance of
SfincsRivers.roughnessInstance of
SfincsRoughness.snapwave_boundary_conditionsInstance of
SnapWaveBoundaryConditions.storage_volumeInstance of
SfincsStorageVolume.subgridInstance of
SfincsSubgridTable.thin_damsInstance of
SfincsThinDams.water_levelInstance of
SfincsWaterLevel.wave_makersInstance of
SfincsWaveMakers.weirsInstance of
SfincsWeirs.windInstance of
SfincsWind.data_catalogDataCatalog for data access
Model root