hydromt_sfincs.components.grid.SfincsInitialConditions

class hydromt_sfincs.components.grid.SfincsInitialConditions(model: SfincsModel)

SFINCS Initial Conditions Component.

This component contains methods to add initial water level data to the SFINCS model on regular grids.

Note

Initial water level is stored in the model grid under the key zs. data exposes only this layer; the component reads and writes it through inifile.

See also

SfincsGrid

__init__(model: SfincsModel)

Methods

__init__(model)
close()	Clean up all open datasets.
create(zsini[, fill_value, reproj_method])	Setup spatially varying initial water level (inifile).
create_from_polygon(zsini[, zsini_value, ...])	Setup spatially varying initial water level (inifile).
finish_write()	Finish the write functionality after cleanup was called for all components in the model.
read()	Read the initial water level map from its own binary file.
test_equal(other)	Test if two components are equal.
write()	Write the initial water level map to its own binary file.

Attributes

data	Return only the available initial-condition layers from the grid.
data_catalog	Return the data catalog of the model this component is associated with.
grid_variables
mask	Get an empty mask with the same shape as the model grid.
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.