hydromt_sfincs.components.forcing.SfincsPrecipitation

class hydromt_sfincs.components.forcing.SfincsPrecipitation(model: SfincsModel)

SFINCS precipitation forcing. This component handles the creation and management of precipitation data for the SFINCS model. It supports both spatially distributed precipitation data (as a NetCDF file) and uniform precipitation data (as a time series).

__init__(model: SfincsModel)

Methods

__init__(model)
clear()	Clear the data attribute.
close()	Clean up all open datasets.
create(precip[, buffer, dst_res, ...])	Setup precipitation forcing from a gridded spatially varying data source.
create_uniform([timeseries, magnitude])	Setup spatially uniform precipitation forcing (precip).
finish_write()	Finish the write functionality after cleanup was called for all components in the model.
read([filename])	Read precipitation data from file.
read_gridded([filename, rename])	Read in gridded meteo data.
read_uniform(variable[, filename])	Read in spatially uniform precipitation data.
set(data[, name])	Add data to grid.
test_equal(other)	Test if two components are equal.
write([filename, fmt])	Write meteo data to file.
write_gridded([filename, rename])	Write spatially varying meteo file as netcdf.
write_uniform(variable[, filename, fmt])	Write uniform meteo file.

Attributes

data	Meteo data.
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.