hydromt_wflow.components.WflowOutputScalarComponent#

class hydromt_wflow.components.WflowOutputScalarComponent(model: Model, *, filename: str = 'output_scalar.nc')[source]#

ModelComponent class for Wflow netcdf_scalar output.

This class is used for reading the Wflow netcdf_scalar output.

The overall output netcdf_scalar component data stored in the data property of this class is a xarray.Dataset.

Initialize the Wflow netcdf_scalar output component.

Parameters:
  • model (Model) – HydroMT model instance.

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

__init__(model: Model, *, filename: str = 'output_scalar.nc')[source]#

Initialize the Wflow netcdf_scalar output component.

Parameters:
  • model (Model) – HydroMT model instance.

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

Methods

__init__(model, *[, filename])

Initialize the Wflow netcdf_scalar 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 netcdf_scalar model output at root/dir_output/filename.

set(data[, name])

Add data to netcdf_scalar output.

test_equal(other)

Test if two components are equal.

write()

Skip writing output files.

Attributes

data

Model netcdf_scalar output data as xarray.Dataset.

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.