hydromt_sfincs.components.grid.SfincsInitialConditions#

class hydromt_sfincs.components.grid.SfincsInitialConditions(model: SfincsModel)[source]#

SFINCS Initial Conditions Component.

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

Note

The initial water level data is stored in the model grid’s data dataset under the key “ini”.

See also

SfincsGrid

__init__(model: SfincsModel)[source]#

Methods

__init__(model)

close()

Clean up all open datasets.

create(ini[, fill_value, reproj_method])

Setup spatially varying initial water level (inifile).

create_from_polygon(ini[, ini_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 file(s) into the component.

test_equal(other)

Test if two components are equal.

write()

Write the component to file(s).

Attributes

data

Get the data from the model grid.

data_catalog

Return the data catalog of the model this component is associated with.

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.