hydromt_sfincs.components.geometries.SfincsDrainageStructures

class hydromt_sfincs.components.geometries.SfincsDrainageStructures(model: SfincsModel)

SFINCS drainage structures component.

This component handles reading, writing, and creating drainage structures such as pumps, culverts, and valves in a SFINCS model.

__init__(model: SfincsModel)

Methods

__init__(model)
close()	Clean up all open datasets.
create(locations[, stype, discharge, merge])	Create drainage structures such as pumps, culverts, or valves (old name: setup_drainage_structures).
finish_write()	Finish the write functionality after cleanup was called for all components in the model.
read([filename])	Read SFINCS drainage structures (.drn) file.
set(gdf[, merge])	Set SFINCS drainage structures.
test_equal(other)	Test if two components are equal.
write([filename])	Write SFINCS drainage structures (.drn) file, and make sure drnfile is in config (if it was not already set).

Attributes

data	Drainage structures data, returns geopandas.GeoDataFrame
data_catalog	Return the data catalog of the model this component is associated with.
model	Return the model object this component is associated with.
name_in_model	Find the name of the component in the parent model components.
root	Return the root of the model this component is associated with.