| Excerpt | ||
|---|---|---|
| ||
Sets the forecast length |
Function: | Sets the forecast length |
|---|
Module Name: | ForecastLengthEstimator |
|---|---|
Where to Use? | In a workflow |
Why to Use? | To set the length of a forecast based on (external) timeseries |
Description: | 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. |
Preconditions: | 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 |
Outcome(s): |
|
Scheendump(s): | link to attached screendump(s) for displays only |
Remark(s): |
|
Available since: | DelftFEWS200803 |
Contents
| Table of Contents |
|---|
Overview
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.
Configuration
A configuration example of the forecast length estimator is given below:
| Code Block | ||||
|---|---|---|---|---|
| ||||
<?xml version="1.0" encoding="UTF-8"?> <forecastLengthEstimator xmlns="http://www.wldelft.nl/fews" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.wldelft.nl/fews http://fews.wldelft.nl/schemas/version1.0/forecastLengthEstimator.xsd"> <externalForecastTimeSeries> <moduleInstanceId>ImportCOSMO2</moduleInstanceId> <valueType>grid</valueType> <parameterId>P.fg</parameterId> <locationId>COSMO2</locationId> <timeSeriesType>external forecasting</timeSeriesType> <timeStep unit="hour" multiplier="1"/> <relativeViewPeriod unit="hour" start="0" end="30"/> <readWriteMode>read only</readWriteMode> </externalForecastTimeSeries> <minForecastLength multiplier="3" unit="hour"/> <maxForecastLength multiplier="30" unit="hour"/> </forecastLengthEstimator> |
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
| Note | ||
|---|---|---|
| ||
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. |
Sample input and output
Sample input and output
Error and warning messages
Description of errors and warnings that may be generated
Error: | Error message |
|---|---|
Action: | Action to fix |
Known issues
Describe all known issues and unexpected behaviour
Related modules and documentation
Links to related parts of the system
Technical reference
Entry in moduleDescriptors: | nl.wldelft.fews.system.plugin.forecastlength.ForecastLengthEstimator |
|---|---|
Link to schema: | http://fews.wldelft.nl/schemas/version1.0/forecastLengthEstimator.xsd |