Sets the forecast length
Where to Use?
In a workflow
Why to Use?
To set the length of a forecast based on (external) timeseries
The forecastLengthEstimator is a module that can be used at the start of a workflow the set the length of the operations in the other modules in that workflow.
the endoverrulable attribute in the relative view period in the time series sets must be set to true in all modules you want to apply the forecast length to
link to attached screendump(s) for displays only
The forecastLengthEstimator is a module that can be used at the start of a workflow to set the length of the operations in the other modules in that workflow. As most models cannot handle gaps in the input data, this option can be useful if you want to run a hydrological model only with the data available and thus avoid e.g. extrapolating the meteorological forecast data.
Forecast time series
A configuration example of the forecast length estimator using an external forecast time series is given below:
The forecast length is defined by the length of the external forecast time series (in this example ImportCOSMO2). You can define a mimimum and / or maximum forecast length (minForcastLength / maxForecastLength). If the actual forecast length of the external forecast looked at is shorter than the minimum forecast length the forecast length is set to this minimum length (in this example 3 hours). If the actual forecast length is longer than the maximum forecast length the forecast length is set to this maximum length (in this example 30 hours).
The logging will provide you with the information which forecast length was used in the run, see example below
 INFO - Workflow.run - Workflow.ActivityStarted: Workflow 'HBV_FlowForecast_ECMWF'
 INFO - WorkflowPluginActivity.run - Started Activity ForecastLength_ECMWF
 INFO - ForecastLengthEstimator.updateForecastLength - ForecastLengthEstimator.Info: Established Forecast Length as 234 hours
Here is a configuration example of the forecast length estimator using a simulated forecast time series. Make sure that your are using the read write mode "read complete forecast" or define a relative view period instead.
The endoverrulable attribute in the relative view period in time series sets must be set to true in all subsequent modules in which you want to use the actual forecast length.
Since 2011.02, the forecastLengthEstimator can also be used to set a fixed end date, e.g. the end of the water year.
As of 2012.02, the forecast length can be forced to the end of the 2nd wateryear by using a combination of <minForecastLength> and <minForecastEndDay>. The code will first evaluate the minForecastLength before evaluating <minForecastEndDay>.
Simulated historical timeseries
This module can also be used to determine the start of the period by finding the last (approved) warm state of a specific moduleinstanceId.
The startoverrulable attribute in the relative view period in time series sets must be set to true in all subsequent modules in which you want to use the actual forecast length. Also make sure the statesearchperiod is the same as defined in the ForecastLengthEstimator.
External historical time series
In contrary to external forecast and simulated forcast time series, external historical time series can not be used to determine the forecast length because they are not forecasts. These time series can be configured but will only be used to determine the last time step of measuments and use that time to set the last observation time which in turn can be used to export to a run file or to set the t0 to the latest available time step.
Sample input and output
Sample input and output
Error and warning messages
Description of errors and warnings that may be generated
Action to fix
Describe all known issues and unexpected behaviour
Related modules and documentation
Links to related parts of the system
Entry in moduleDescriptors:
Link to schema: