OPT-file: Difference between revisions
mNo edit summary |
m (→Description) |
||
(16 intermediate revisions by 3 users not shown) | |||
Line 1: | Line 1: | ||
{{ | {{Template:BlueM.Opt input files}} | ||
<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]]. | |||
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. | |||
'' | ''Example with 4 optimization parameters (calibration of a rainfall-runoff model by optimizing runoff coefficient and retention constants):'' | ||
< | <bluem> | ||
* | *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 | > | | ||
*|--------------|-------|-------------|--------|--------|-----------| | |||
</bluem> | |||
=== | ===Description=== | ||
:{| cellpadding=" | :{| cellpadding="5" cellspacing="0" border="0" class="standard stripes" | ||
|- | |- | ||
| ''' | ! width="100" | Parameter !! width="400" | Description | ||
|- | |- | ||
| ''' | | '''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'' | ||
|- | |- | ||
| '''Min''' & '''Max''' || | | '''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)'' | |||
* <code> </code> (no relation) | |||
* <code><</code> (smaller than) | |||
* <code><=</code> (smaller or equal than) | |||
* <code>></code> (larger than) | |||
* <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. | |||
'''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 (<code>|</code>) must be preserved! | |||
An asterisk (<code>*</code>) at the beginning of the line causes the line to be ignored. | |||
[[ | [[Category:BlueM.Opt input files|O]] | ||
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 parametersUnit 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) <
(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.