Schema wflowModelFactoryConfig.xsd


element wflowModelFactoryConfig
diagram wflowModelFactoryConfig_diagrams/wflowModelFactoryConfig_p1.png
annotation
documentation
Configuration for a WFLOW model factory. It contains information on the Python module that contains the model to use and the input and output files for the model.

complexType WflowConfigurableXML
diagram wflowModelFactoryConfig_diagrams/wflowModelFactoryConfig_p2.png
attributes
Name  Type  Use  Default  Fixed  Annotation
className  xs:string  required      
documentation
Specify the openda:class name for performing this operation

attribute WflowConfigurableXML/@className
annotation
documentation
Specify the openda:class name for performing this operation

element WflowConfigurableXML/configFile
diagram wflowModelFactoryConfig_diagrams/wflowModelFactoryConfig_p3.png
annotation
documentation
Specify the configuration filename

element WflowConfigurableXML/configString
diagram wflowModelFactoryConfig_diagrams/wflowModelFactoryConfig_p4.png
annotation
documentation
Specify the configuration string

element WflowConfigurableXML/arg
diagram wflowModelFactoryConfig_diagrams/wflowModelFactoryConfig_p5.png
annotation
documentation
Specify the input argument of this openda:class

complexType WflowDateTimeXML
diagram wflowModelFactoryConfig_diagrams/wflowModelFactoryConfig_p6.png
attributes
Name  Type  Use  Default  Fixed  Annotation
date  openda:WflowDateXML  required      
time  openda:WflowTimeXML  required      

attribute WflowDateTimeXML/@date

attribute WflowDateTimeXML/@time

complexType WflowIndicesXML
diagram wflowModelFactoryConfig_diagrams/wflowModelFactoryConfig_p7.png
attributes
Name  Type  Use  Default  Fixed  Annotation
index1  openda:indexStringType  required      
documentation
Indices of the selected array elements of the first dimension. Format:  "ind1" (single index)," ind1:" (from ind1 up to the last index), ":ind1" (from the first index up to ind1), "ind1:ind2" (from ind1 up to ind2). Example: 8, :4, 19:, 7:12.
index2  openda:indexStringType  optional      
documentation
Indices of the selected array elements of the second dimension. Format:  "ind1" (single index)," ind1:" (from ind1 up to the last index), ":ind1" (from the first index up to ind1), "ind1:ind2" (from ind1 up to ind2). Example: 8, :4, 19:, 7:12.
index3  openda:indexStringType  optional      
documentation
Indices of the selected array elements of the third dimension. Format:  "ind1" (single index)," ind1:" (from ind1 up to the last index), ":ind1" (from the first index up to ind1), "ind1:ind2" (from ind1 up to ind2). Example: 8, :4, 19:, 7:12.
base  xs:int  optional  0    
documentation
Base number, which gives the index of the vector's first element (sometimes 1 instead of 0)

attribute WflowIndicesXML/@index1
annotation
documentation
Indices of the selected array elements of the first dimension. Format:  "ind1" (single index)," ind1:" (from ind1 up to the last index), ":ind1" (from the first index up to ind1), "ind1:ind2" (from ind1 up to ind2). Example: 8, :4, 19:, 7:12.

attribute WflowIndicesXML/@index2
annotation
documentation
Indices of the selected array elements of the second dimension. Format:  "ind1" (single index)," ind1:" (from ind1 up to the last index), ":ind1" (from the first index up to ind1), "ind1:ind2" (from ind1 up to ind2). Example: 8, :4, 19:, 7:12.

attribute WflowIndicesXML/@index3
annotation
documentation
Indices of the selected array elements of the third dimension. Format:  "ind1" (single index)," ind1:" (from ind1 up to the last index), ":ind1" (from the first index up to ind1), "ind1:ind2" (from ind1 up to ind2). Example: 8, :4, 19:, 7:12.

attribute WflowIndicesXML/@base
annotation
documentation
Base number, which gives the index of the vector's first element (sometimes 1 instead of 0)

complexType WflowModelFactoryConfigXML
diagram wflowModelFactoryConfig_diagrams/wflowModelFactoryConfig_p8.png

element WflowModelFactoryConfigXML/pythonModuleName
diagram wflowModelFactoryConfig_diagrams/wflowModelFactoryConfig_p9.png
annotation
documentation
The name of the Python module that contains the model to use, e.g. wflow_hbv.

element WflowModelFactoryConfigXML/timeHorizon
diagram wflowModelFactoryConfig_diagrams/wflowModelFactoryConfig_p10.png
annotation
documentation
Optional run period for the model. If the timeHorizon is set from 'outside' (e.g. when running from an operational system), then that timeHorizon overrules the timeHorizon that is configured here (if this is present). For runs with only OpenDA the timeHorizon for the model must be configured here.

element WflowModelFactoryConfigXML/caseDirectory
diagram wflowModelFactoryConfig_diagrams/wflowModelFactoryConfig_p11.png
annotation
documentation
Case directory path (relative to this configuration file).

element WflowModelFactoryConfigXML/templateRunId
diagram wflowModelFactoryConfig_diagrams/wflowModelFactoryConfig_p12.png
annotation
documentation
Base name of the run id within the current case (relative to the case directory). The number of the instance will be appended to this base name to create the instance run id (instance directory name).

element WflowModelFactoryConfigXML/modelConfigFileName
diagram wflowModelFactoryConfig_diagrams/wflowModelFactoryConfig_p13.png
annotation
documentation
The name of the model configuration file (relative to the case directory).

element WflowModelFactoryConfigXML/cloneMapFileName
diagram wflowModelFactoryConfig_diagrams/wflowModelFactoryConfig_p14.png
annotation
documentation
The name of the map file that describes the catchment (relative to the staticmaps folder in the case directory).

element WflowModelFactoryConfigXML/inputFile
diagram wflowModelFactoryConfig_diagrams/wflowModelFactoryConfig_p15.png
annotation
documentation
The path and name of one or more input netcdf files (relative to the case directory). Together these input files must contain all (boundary) input data that is needed for the model to run. If the (boundary) input data should be different for different model instances, then use the option boundaryProvider in the blackBoxStochModel config instead.

element WflowModelFactoryConfigXML/modelOutputFile
diagram wflowModelFactoryConfig_diagrams/wflowModelFactoryConfig_p16.png
annotation
documentation
The path and name of the model output netcdf file (relative to the instance directory). This file will be created during the model run. After each model timestep the model output data will be written to this file.

element WflowModelFactoryConfigXML/analysisOutputFile
diagram wflowModelFactoryConfig_diagrams/wflowModelFactoryConfig_p17.png
annotation
documentation
The path and name of the analysis output netcdf file (relative to the instance directory). This file will be created during the model run. After each analysis time the updated state will be written to this file.

element WflowModelFactoryConfigXML/outputExchangeItemId
diagram wflowModelFactoryConfig_diagrams/wflowModelFactoryConfig_p18.png
annotation
documentation
Selection of exchange items to be included in the model and analysis output files (2D gridded data).

element WflowModelFactoryConfigXML/scalarModelOutput
diagram wflowModelFactoryConfig_diagrams/wflowModelFactoryConfig_p19.png
annotation
documentation
Specification of scalar model output to be written to output netcdf files.

element WflowModelFactoryConfigXML/scalarModelOutput/modelOutputFile
diagram wflowModelFactoryConfig_diagrams/wflowModelFactoryConfig_p20.png
annotation
documentation
The path and name of the model output netcdf file (relative to the instance directory). This file will be created during the model run. After each model timestep the model output data will be written to this file.

element WflowModelFactoryConfigXML/scalarModelOutput/analysisOutputFile
diagram wflowModelFactoryConfig_diagrams/wflowModelFactoryConfig_p21.png
annotation
documentation
The path and name of the analysis output netcdf file (relative to the instance directory). This file will be created during the model run. After each analysis time the updated state will be written to this file.

element WflowModelFactoryConfigXML/scalarModelOutput/subVector
diagram wflowModelFactoryConfig_diagrams/wflowModelFactoryConfig_p22.png
attributes
Name  Type  Use  Default  Fixed  Annotation
id  xs:string  required      
documentation
Identity of the subVector
sourceVectorId  xs:string  optional      
documentation
Identity of the source vector as defined in blackBoxModelConfig
annotation
documentation
Specification of source exchange items and their corresponding selection.

complexType WflowScalarModelOutput
diagram wflowModelFactoryConfig_diagrams/wflowModelFactoryConfig_p23.png
attributes
Name  Type  Use  Default  Fixed  Annotation
id  xs:string  required      
documentation
Identity of the subVector
sourceVectorId  xs:string  optional      
documentation
Identity of the source vector as defined in blackBoxModelConfig

attribute WflowScalarModelOutput/@id
annotation
documentation
Identity of the subVector

attribute WflowScalarModelOutput/@sourceVectorId
annotation
documentation
Identity of the source vector as defined in blackBoxModelConfig

element WflowScalarModelOutput/selection
diagram wflowModelFactoryConfig_diagrams/wflowModelFactoryConfig_p24.png
attributes
Name  Type  Use  Default  Fixed  Annotation
index1  openda:indexStringType  required      
documentation
Indices of the selected array elements of the first dimension. Format:  "ind1" (single index)," ind1:" (from ind1 up to the last index), ":ind1" (from the first index up to ind1), "ind1:ind2" (from ind1 up to ind2). Example: 8, :4, 19:, 7:12.
index2  openda:indexStringType  optional      
documentation
Indices of the selected array elements of the second dimension. Format:  "ind1" (single index)," ind1:" (from ind1 up to the last index), ":ind1" (from the first index up to ind1), "ind1:ind2" (from ind1 up to ind2). Example: 8, :4, 19:, 7:12.
index3  openda:indexStringType  optional      
documentation
Indices of the selected array elements of the third dimension. Format:  "ind1" (single index)," ind1:" (from ind1 up to the last index), ":ind1" (from the first index up to ind1), "ind1:ind2" (from ind1 up to ind2). Example: 8, :4, 19:, 7:12.
base  xs:int  optional  0    
documentation
Base number, which gives the index of the vector's first element (sometimes 1 instead of 0)
annotation
documentation
Select subvector using indices of the vector elements

element WflowScalarModelOutput/selector
diagram wflowModelFactoryConfig_diagrams/wflowModelFactoryConfig_p25.png
attributes
Name  Type  Use  Default  Fixed  Annotation
className  xs:string  required      
documentation
Specify the openda:class name for performing this operation
annotation
documentation
Define operator for deriving the subvector

complexType WflowTimeHorizonXML
diagram wflowModelFactoryConfig_diagrams/wflowModelFactoryConfig_p26.png

element WflowTimeHorizonXML/startDateTime
diagram wflowModelFactoryConfig_diagrams/wflowModelFactoryConfig_p27.png
attributes
Name  Type  Use  Default  Fixed  Annotation
date  openda:WflowDateXML  required      
time  openda:WflowTimeXML  required      
annotation
documentation
Start of the model run.

element WflowTimeHorizonXML/endDateTime
diagram wflowModelFactoryConfig_diagrams/wflowModelFactoryConfig_p28.png
attributes
Name  Type  Use  Default  Fixed  Annotation
date  openda:WflowDateXML  required      
time  openda:WflowTimeXML  required      
annotation
documentation
End of the model run.

element WflowTimeHorizonXML/timeZoneOffset
diagram wflowModelFactoryConfig_diagrams/wflowModelFactoryConfig_p29.png
annotation
documentation
The time zone in which the startDateTime and endDateTime of the model run are specified. This should be the offset of the timeZone with respect to GMT, in hours between -12 and 12.

simpleType indexStringType
annotation
documentation
index (e.g. 12) or index line (e.g. 11:18) in an array

simpleType WflowDateXML

simpleType WflowTimeXML


XML Schema documentation generated by XMLSpy Schema Editor http://www.altova.com/xmlspy