OPT-file: Difference between revisions

Latest revision as of 03:01, 28 October 2020

BlueM.Opt | Download | Usage | Development

BlueM.Opt input files: MOD · OPT · OBF · CON

Versions:

current v1.7 (as of r1779)
v1.6 and older

This file defines the parameters that are to be optimized. Each line corresponds to one optimization parameter. Each optimization parameter can be used to calculate one or more model parameters.

This file must have the same filename as the rest of the simulation dataset but have the file extension .OPT, and be located in the same directory as the rest of the dataset.

Example with 4 optimization parameters (calibration of a rainfall-runoff model by optimizing runoff coefficient and retention constants):

*Optimization parameters
*=======================
*
*|--------------|-------|-------------|--------|--------|-----------|
*| Name         | Unit  | Start value |  Min   |  Max   | Relation  |
*|-<---------->-|-<--->-|-<--------->-|-<---->-|-<---->-|-<------->-|
 | RunoffCoeff  |   -   |    0.5      |   0.1  |   0.9  |           |
 | RetConstV    |   -   |    1        |   0.1  |    10  |           |
 | RetConst1    |   -   |    1        |   0.1  |    10  |     >     |
 | RetConst2    |   -   |    1        |   0.1  |    10  |     >     |
*|--------------|-------|-------------|--------|--------|-----------|

Description

Parameter	Description
Name	Name of the optimization parameter (arbitrary) This name is also used in the MOD-file so that model parameters can be associated with optimization parameters
Unit	Unit of the parameter value (optional)
Start value	Start value for the parameter
Min & Max	Lower and upper bound for the parameter value
Relation	Optional relation to another optimization parameter. The relation is defined as a constraint of the parameter's value in regard to the value of the optimization parameter on the previous line. (#241) (no relation) `<` (smaller than) `<=` (smaller or equal than) `>` (larger than) `>=` (larger or equal than) If a relation is specified, the algorithm makes sure that the relation is always adhered to by generating new parameter values up to 1000 times if necessary, until the defined relation is satisfied. If, after 1000 tries, the relation is still not satisfied, the algorithm attempts to adjust the parent parameter value and tries again. WARNING: This can cause an infinite loop under some circumstances (#743)! It is advisable to use relations as sparingly as possible and in particular to avoid multiple consecutive relations.

The width of the columns can be adjusted if necessary, but the column separators (|) must be preserved!

An asterisk (*) at the beginning of the line causes the line to be ignored.

@@ Line 1: / Line 1: @@
-{{Vorlage:BlueM.Opt Eingabedateien}}
+{{Template:BlueM.Opt input files}}
-Diese Datei definiert die zu optimierenden Parameter. Jede Zeile entspricht einem Parameter. Aus jedem Optimierungsparameter lassen sich mehrere [[MOD-Datei|Modellparameter]] berechnen.
+<div class="info_versionen">
+'''Versions:'''
+* '''current''' v1.7 (as of r1779)
+* [{{SERVER}}/index.php?title=OPT-file&oldid=7258 v1.6 and older]
+</div>
+This file defines the parameters that are to be optimized. Each line corresponds to one optimization parameter. Each optimization parameter can be used to calculate one or more [[MOD-file|model parameters]].
-Die Datei muss den gleichen Namen wie der Simulations-Datensatz haben, aber mit der Endung '''.OPT''', und muss sich im Simulations-Arbeitsverzeichnis befinden.
+This file must have the same filename as the rest of the simulation dataset but have the file extension '''<code>.OPT</code>''', and be located in the same directory as the rest of the dataset.
-''Beispiel mit 4 Optimierungsparametern (Abflussbeiwert und Retentionskonstanten):''
+''Example with 4 optimization parameters (calibration of a rainfall-runoff model by optimizing runoff coefficient and retention constants):''
 <bluem>
-*Optimierungsparameter
+*Optimization parameters
-*=====================
+*=======================
 *
-*|--------------|-------|-----------|--------|--------|-----------|----------|-----------|
+*|--------------|-------|-------------|--------|--------|-----------|
-*| Bezeichnung  | Einh. | Anfangsw. |  Min   |  Max   | Beziehung |  Objekt  | Zeitpunkt |
+*| Name         | Unit  | Start value |  Min   |  Max   | Relation  |
-*|-<---------->-|-<--->-|-<------->-|-<---->-|-<---->-|-<------->-|-<------>-|-<------->-|
+*|-<---------->-|-<--->-|-<--------->-|-<---->-|-<---->-|-<------->-|
-  | PSI          |   -   |    0.5    |   0.1  |   0.9  |           |          |           |
+  | RunoffCoeff  |   -   |    0.5      |   0.1  |   0.9  |           |
-  | RetKonstV    |   -   |    1      |   0.1  |    10  |           |          |           |
+  | RetConstV    |   -   |    1        |   0.1  |    10  |           |
-  | RetKonst1    |   -   |    1      |   0.1  |    10  |     >     |          |           |
+  | RetConst1    |   -   |    1        |   0.1  |    10  |     >     |
-  | RetKonst2    |   -   |    1      |   0.1  |    10  |     >     |          |           |
+  | RetConst2    |   -   |    1        |   0.1  |    10  |     >     |
-*|--------------|-------|-----------|--------|--------|-----------|----------|-----------|
+*|--------------|-------|-------------|--------|--------|-----------|
 </bluem>
-===Spaltenbeschreibung===
+===Description===
 :{| cellpadding="5" cellspacing="0" border="0" class="standard stripes"
 |-
-! width="100" | Parameter !! width="400" | Beschreibung
+! width="100" | Parameter !! width="400" | Description
 |-
-| '''Bezeichnung''' || Bezeichnung des Parameters (beliebig)<br/>''Diese Bezeichnung muss sich in der [[MOD-Datei]] wiederfinden, damit eine Zuordnung gemacht werden kann)''
+| '''Name''' || Name of the optimization parameter (arbitrary)<br/>''This name is also used in the [[MOD-file]] so that model parameters can be associated with optimization parameters''
 |-
-| '''Einh.''' || Einheit des Parameterwertes
+| '''Unit''' || Unit of the parameter value (optional)
 |-
-| '''Anfangsw.''' || Anfangswert für den Parameter
+| '''Start value''' || Start value for the parameter
 |-
-| '''Min''' & '''Max''' || Untere und obere Grenze für den Parameterwert
+| '''Min''' & '''Max''' || Lower and upper bound for the parameter value
 |-
-| '''Beziehung''' || Einzuhaltende Beziehung zum vorhergehenden OptParameter<br/>''(Bug 241)''
+| '''Relation''' || Optional relation to another optimization parameter. The relation is defined as a constraint of the parameter's value in regard to the value of the optimization parameter on the previous line. ''(#241)''
-* <code>&nbsp;</code> (keine Beziehung)
+* <code>&nbsp;</code> (no relation)
-* <code><</code> (kleiner)
+* <code><</code> (smaller than)
-* <code><=</code> (kleiner gleich)
+* <code><=</code> (smaller or equal than)
-* <code>></code> (größer)
+* <code>></code> (larger than)
-* <code>>=</code> (größer gleich)
+* <code>>=</code> (larger or equal than)
-|-
+If a relation is specified, the algorithm makes sure that the relation is always adhered to by generating new parameter values up to 1000 times if necessary, until the defined relation is satisfied. If, after 1000 tries, the relation is still not satisfied, the algorithm attempts to adjust the parent parameter value and tries again.
-| '''Objekt''' || Optionaler Parameter für die prädikative Steuerung, damit für das wandernde Zeitfenster eine eindeutige Reihenfolge ermittelt werden kann. Muss aus der Kombination "OBJECT Name ATTRIBUT" bestehen, z.B. "ORIFICE Gate SETTING".
+'''WARNING''': This can cause an infinite loop under some circumstances (#743)! It is advisable to use relations as sparingly as possible and in particular to avoid multiple consecutive relations.
-|-
-| '''Zeitpunkt''' || Optionaler Paramter für die prädikative Steuerung, damit für das wandernde Zeitfenster eine eindeutige Reihenfolge ermittelt werden kann.
 |}
-Die Breite der Spalten darf bei Bedarf angepasst werden, nur alle "|"-Zeichen müssen erhalten bleiben!
+The width of the columns can be adjusted if necessary, but the column separators (<code>|</code>) must be preserved!
-Ein "<code>*</code>" am Anfang einer Zeile führt dazu, dass die Zeile ignoriert wird.
+An asterisk (<code>*</code>) at the beginning of the line causes the line to be ignored.
-[[Kategorie:BlueM.Opt Eingabedateien]]
+[[Category:BlueM.Opt input files|O]]

OPT-file: Difference between revisions

Latest revision as of 03:01, 28 October 2020

Description

Navigation menu

Search