Tips for ABINIT users and developers

User Tools

Site Tools

Trace:
developers:abivars.yml

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
Last revisionBoth sides next revision
developers:abivars.yml [2017/08/04 08:56] – [Strings] Xavier Gonzedevelopers: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/doc/input_variables/origin_files/abinit_vars.yml file, you can specify numbers, string, arrays, following the standard specification of YAML.+** THE INFORMATION ABOUT THE MANAGEMENT OF THE DOCUMENTATION HAS BEEN TRANSFERRED TO THE MAIN ABINIT SITE, AT  
 +https://docs.abinit.org/developers/abimkdocs ** 
 + 
 +As values in the ~abinit/doc/input_variables/origin_files/abinit_vars.yml file, you can specify numbers, string, arrays, following the standard specification of YAML : 
 + 
 +  * [[http://en.wikipedia.org/wiki/YAML| Wikipedia YAML page]] 
 +  * [[http://www.yaml.org/|The official YAML page]] 
 + 
 +===== Strings ===== 
 + 
 +Pay attention to strings, as YAML is used. If a chain of character is recognized directly to be a string by YAML, you don't need ticks (' '). 
 +Otherwise, you need to put ticks.  
 + 
 +For example, if you want to use a link as a value, use a link shortcut like <nowiki>[[abivarname]]</nowiki>, but pay attention, sometimes, you will need <nowiki>'[[abivarname]]'</nowiki>. See the doc about link shortcuts at [[developers:link_shortcuts]].  
 + 
 +===== Types =====
  
 Several "types" are defined to allow sufficient flexibility in the specifications, as follows. Several "types" are defined to allow sufficient flexibility in the specifications, as follows.
Line 19: Line 34:
   * requires : the input variable is relevant only if this condition is fulfilled   * requires : the input variable is relevant only if this condition is fulfilled
   * text : free text describing the input variable   * text : free text describing the input variable
-  * topics : a list of strings+  * topics : a string, specified in [[developers:topics_and_relevances|topics and relevances]]
   * varset : a unique "set of variables" to which the variable belong. To be chosen among the names in ~abinit/doc/input_variables/origin_files/varsets.yml .   * varset : a unique "set of variables" to which the variable belong. To be chosen among the names in ~abinit/doc/input_variables/origin_files/varsets.yml .
   * vartype : to be chosen among integer, real or string   * vartype : to be chosen among integer, real or string
Line 89: Line 104:
 If a varname has as "excludes: CONDITION", it means that the specification of the variable in the input file forbids the CONDITION to be fulfilled. If a varname has as "excludes: CONDITION", it means that the specification of the variable in the input file forbids the CONDITION to be fulfilled.
  
-===== 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 a link shortcut like <nowiki>[[abivarname]]</nowiki>. See the doc about link shortcuts at [[developers:link_shortcuts]].