Schema bmiModelFactoryConfig.xsd


element bmiModelFactoryConfig
diagram bmiModelFactoryConfig_diagrams/bmiModelFactoryConfig_p1.png
annotation
documentation
Configuration for a BMI 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 BmiModelFactoryConfigXML
diagram bmiModelFactoryConfig_diagrams/bmiModelFactoryConfig_p2.png

element BmiModelFactoryConfigXML/pythonModel
diagram bmiModelFactoryConfig_diagrams/bmiModelFactoryConfig_p3.png
annotation
documentation
BMI model that is written in Python.

element BmiModelFactoryConfigXML/modelTemplateDirectory
diagram bmiModelFactoryConfig_diagrams/bmiModelFactoryConfig_p4.png
annotation
documentation
Path and name of the model template directory (relative to this configuration file). This directory will be cloned to create instance directories called work0, work1, work2, etc. The work directories will be created next to the model template directory, i.e. with the same parent directory. Before each run, any work directories from previous runs will be removed.

element BmiModelFactoryConfigXML/modelConfigFile
diagram bmiModelFactoryConfig_diagrams/bmiModelFactoryConfig_p5.png
annotation
documentation
The path and name of the model configuration file (relative to the model template directory).

element BmiModelFactoryConfigXML/inputStateDirectory
diagram bmiModelFactoryConfig_diagrams/bmiModelFactoryConfig_p6.png
annotation
documentation
The directory in the model instance that contains the input state

element BmiModelFactoryConfigXML/outputStateDirectory
diagram bmiModelFactoryConfig_diagrams/bmiModelFactoryConfig_p7.png
annotation
documentation
The directory in the model instance that contains the input state

element BmiModelFactoryConfigXML/hosts
diagram bmiModelFactoryConfig_diagrams/bmiModelFactoryConfig_p8.png
annotation
documentation
DEPRECATED: This element will probably be removed in future.

element BmiModelFactoryConfigXML/bmiModelForcingsConfig
diagram bmiModelFactoryConfig_diagrams/bmiModelFactoryConfig_p9.png

element BmiModelFactoryConfigXML/bmiModelStateExchangeItems
diagram bmiModelFactoryConfig_diagrams/bmiModelFactoryConfig_p10.png

element BmiModelFactoryConfigXML/missingValue
diagram bmiModelFactoryConfig_diagrams/bmiModelFactoryConfig_p11.png
annotation
documentation
NaN or a valid double value, indicating a missing value in the model data. Default: NaN

complexType BmiModelForcingsConfigXML
diagram bmiModelFactoryConfig_diagrams/bmiModelFactoryConfig_p12.png

element BmiModelForcingsConfigXML/dataObject
diagram bmiModelFactoryConfig_diagrams/bmiModelFactoryConfig_p13.png
annotation
documentation
The data object containing the forcing data.

complexType BmiModelStateExchangeItemXML
diagram bmiModelFactoryConfig_diagrams/bmiModelFactoryConfig_p14.png

element BmiModelStateExchangeItemXML/limitedExchangeItem
diagram bmiModelFactoryConfig_diagrams/bmiModelFactoryConfig_p15.png

element BmiModelStateExchangeItemXML/limitedExchangeItem/exchangeItemId
diagram bmiModelFactoryConfig_diagrams/bmiModelFactoryConfig_p16.png
annotation
documentation
Name of a State ExchangeItem.

element BmiModelStateExchangeItemXML/limitedExchangeItem/lowerLimit
diagram bmiModelFactoryConfig_diagrams/bmiModelFactoryConfig_p17.png
annotation
documentation
Optional. If the value of a model exchange item is below the lower limit, then the value is changed to the lower limit.

element BmiModelStateExchangeItemXML/limitedExchangeItem/upperLimit
diagram bmiModelFactoryConfig_diagrams/bmiModelFactoryConfig_p18.png
annotation
documentation
Optional. If the value of a model exchange item is above the upper limit, then the value is changed to the upper limit.

complexType BmiPythonModelXML
diagram bmiModelFactoryConfig_diagrams/bmiModelFactoryConfig_p19.png

element BmiPythonModelXML/pythonPath
diagram bmiModelFactoryConfig_diagrams/bmiModelFactoryConfig_p20.png
annotation
documentation
Path that contains the Python code of the model (relative to this configuration file).

element BmiPythonModelXML/moduleName
diagram bmiModelFactoryConfig_diagrams/bmiModelFactoryConfig_p21.png
annotation
documentation
The (fully qualified) name of the Python module that contains the class specified in className, e.g. wflow_bmi.

element BmiPythonModelXML/className
diagram bmiModelFactoryConfig_diagrams/bmiModelFactoryConfig_p22.png
annotation
documentation
The name of the Python class that implements the BMI interface, e.g. wflowbmi.

element BmiPythonModelXML/pythonExecutable
diagram bmiModelFactoryConfig_diagrams/bmiModelFactoryConfig_p23.png
annotation
documentation
The full path to the Python executable. TODO this should be a choice between pythonExecutable and the other three elements.

complexType ForcingDataObjectXML
diagram bmiModelFactoryConfig_diagrams/bmiModelFactoryConfig_p24.png

element ForcingDataObjectXML/className
diagram bmiModelFactoryConfig_diagrams/bmiModelFactoryConfig_p25.png
annotation
documentation
The openda class name of the forcing's data object.

element ForcingDataObjectXML/file
diagram bmiModelFactoryConfig_diagrams/bmiModelFactoryConfig_p26.png
annotation
documentation
Name of the forcing's data file.

element ForcingDataObjectXML/arg
diagram bmiModelFactoryConfig_diagrams/bmiModelFactoryConfig_p27.png
annotation
documentation
Input argument(s) for the corresponding openda:class


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