developers:abivars.yml
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionLast revisionBoth sides next revision | ||
developers:abivars.yml [2017/07/31 21:47] – [Constraints between variables] Xavier Gonze | developers:abivars.yml [2018/05/26 22:44] – [Specifications for the abinit_vars.yml file] Xavier Gonze | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== Specifications for the abinit_vars.yml file ====== | + | ====== Specifications for the abinit_vars.yml file (Obsolete) |
- | As values in the ~abinit/ | + | ** THE INFORMATION ABOUT THE MANAGEMENT OF THE DOCUMENTATION HAS BEEN TRANSFERRED TO THE MAIN ABINIT SITE, AT |
+ | https:// | ||
+ | |||
+ | As values in the ~abinit/ | ||
+ | |||
+ | * [[http://en.wikipedia.org/ | ||
+ | * [[http:// | ||
===== Strings ===== | ===== Strings ===== | ||
- | Pay attention to strings. If it is recognized | + | Pay attention to strings, as YAML is used. If a chain of character |
Otherwise, you need to put ticks. | Otherwise, you need to put ticks. | ||
- | For example, if you want to use a link as a value, use < | + | For example, if you want to use a link as a value, use a link shortcut like < |
+ | |||
+ | ===== Types ===== | ||
+ | |||
+ | Several " | ||
===== !variable ===== | ===== !variable ===== | ||
- | Is the type that contains the other fields. | + | It is the type that contains the other fields. |
* abivarname : the name of the variable. Note that the name for input variables of the executables anaddb, aim and optic is always finished with @anaddb, @aim or @optic. | * abivarname : the name of the variable. Note that the name for input variables of the executables anaddb, aim and optic is always finished with @anaddb, @aim or @optic. | ||
- | * characteristics | + | * characteristics |
- | * commentdefault | + | * commentdefault |
- | * commentdims | + | * commentdims |
- | * defaultval | + | * defaultval |
- | * dimensions | + | * dimensions |
- | * excludes | + | * excludes |
- | * menemonics | + | * mnemonics : a longer description of the variable role, in a few words |
- | * requires | + | * requires |
- | * text | + | * text : free text describing the input variable |
- | * topics | + | * topics |
- | * varset | + | * varset |
* vartype : to be chosen among integer, real or string | * vartype : to be chosen among integer, real or string | ||
+ | If there is no information of a type for a specific variable, its value must be " | ||
===== !multiplevalue ===== | ===== !multiplevalue ===== | ||
Line 93: | Line 104: | ||
If a varname has as " | If a varname has as " | ||
- | ===== Strings ===== | ||
- | |||
- | Pay attention to strings. If it is recognized as string directly, you don't need ticks (' '). | ||
- | Otherwise, you need to put ticks. | ||
- | For example, if you want to use a link as a value, use < | ||