Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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.

Forecast time series

A configuration example of the forecast length estimator using an external forecast time series is given below:

...

Code Block
xml
xml
	<minForecastLength multiplier="365" unit="day"/>
	<minForecastEndDay>--09-30</minForecastEndDay>

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.

Code Block
xml
xml
<?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">
	<externalHistoricalTimeSeries>
		<moduleInstanceId>test</moduleInstanceId>
		<valueType>scalar</valueType>
		<parameterId>par</parameterId>
		<locationId>loc</locationId>
		<timeSeriesType>external historical</timeSeriesType>
		<timeStep unit="hour"/>
		<relativeViewPeriod unit="hour" start="-5" end="0"/>
		<readWriteMode>read only</readWriteMode>
	</externalHistoricalTimeSeries>
	<setTime0ToLatestNonMissing>true</setTime0ToLatestNonMissing>
</forecastLengthEstimator>

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