hydromt_sfincs.components.output.SfincsOutput

class hydromt_sfincs.components.output.SfincsOutput(model: SfincsModel)

SFINCS model output component.

This component handles reading and storing model results from SFINCS. The results are stored in a dictionary and can be accessed via the data property.

__init__(model: SfincsModel)

Methods

__init__(model)
close()	Clean up all open datasets.
finish_write()	Finish the write functionality after cleanup was called for all components in the model.
read([chunksize, drop, fn_map, fn_his])	Read results from sfincs_map.nc and sfincs_his.nc and save to the results attribute.
read_his_file([fn_his, drop, chunksize])	Read the sfincs_his.nc file and return it as an xarray Dataset.
read_map_file([fn_map, drop])	Read the sfincs_map.nc file and return it as an xarray Dataset.
set(data[, name, split_dataset])	Add data to results attribute.
test_equal(other)	Test if two components are equal.
write()	Writing results to sfincs_map.nc and sfincs_his.nc files is not part of the hydromt.sfincs package.

Attributes

data	Model results.
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.