hydromt_wflow.components.WflowOutputCsvComponent#

class hydromt_wflow.components.WflowOutputCsvComponent(model: Model, *, filename: str = 'output.csv', locations_component: str | None = None)[source]#

ModelComponent class for Wflow csv output.

This class is used for reading the Wflow csv output.

The overall output csv component data stored in the data property of this class is of the hydromt.gis.vector.GeoDataset type which is an extension of xarray.Dataset for vector data.

Initialize the Wflow csv output component.

Parameters:

  • model (Model) – HydroMT model instance.

  • filename (str, optional) – Default path relative to the root where the csv output file will be read and written. By default ‘output.csv’.

  • locations_component (str, optional) – Name of the locations component to use for reading the output and mapping them to right geo-locations.

__init__(model: Model, *, filename: str = 'output.csv', locations_component: str | None = None)[source]#

Initialize the Wflow csv output component.

Parameters:

  • model (Model) – HydroMT model instance.

  • filename (str, optional) – Default path relative to the root where the csv output file will be read and written. By default ‘output.csv’.

  • locations_component (str, optional) – Name of the locations component to use for reading the output and mapping them to right geo-locations.

Methods

__init__(model, *[, filename, ...])

Initialize the Wflow csv output component.

close()

Clean up all open datasets.

finish_write()

Finish the write functionality after cleanup was called for all components in the model.

read()

Read csv model output at root/dir_output/filename.

set(data[, name, split_dataset])

Add data to the xarray component.

test_equal(other)

Test if two DatasetsComponents are equal.

write()

Skip writing output files.

Attributes

data

Model data in the form of xarray objects.

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.