Currently when using Model.increment_timestep() you can update state (and now static w/ PR #51) variable values before running the computation. This allows modules to interact with other 3rd party models.
As of now, you need to provide a dictionary with variable names as keys, and an updated xr.DataArray as values. This was largely fine for state variables, as we tend to model them over a spatial domain. However, static variables may be better represented by a single number. While the user has the opportunity to adjust the last timestep of the xr.Dataset variable, that is more cumbersome than simply updating with a single float for the whole domain.
I also want to rename the argument to update_values while I am at it.
Currently when using
Model.increment_timestep()you can update state (and now static w/ PR #51) variable values before running the computation. This allows modules to interact with other 3rd party models.As of now, you need to provide a dictionary with variable names as keys, and an updated
xr.DataArrayas values. This was largely fine for state variables, as we tend to model them over a spatial domain. However, static variables may be better represented by a single number. While the user has the opportunity to adjust the last timestep of thexr.Datasetvariable, that is more cumbersome than simply updating with a single float for the whole domain.I also want to rename the argument to
update_valueswhile I am at it.