Changes between Version 5 and Version 6 of doc/app/palm_config

Timestamp:

May 25, 2018 6:40:09 AM (7 years ago)

Author:

raasch

Comment:

--

doc/app/palm_config

@@ -37 +37 @@
 # this is a comment line
 }}}
+
 * lines starting with a {{{%}}} in the first column are defining unix environment variables used in {{{palmrun}}} and {{{palmbuild}}}.
 {{{
 %var value of var
 }}}
-means that a variable named {{{var}}} with value {{{value of var}}} is created. There must be at least one blank between the variable name and its value. The value may contain an arbitrary number of blanks. The value can contain already defined variables:
+  means that a variable named {{{var}}} with value {{{value of var}}} is created. There must be at least one blank between the variable name and its value. The value may contain an arbitrary number of blanks. The value can contain already defined variables:
 {{{
 %default_folder  /work/abcd
 %subfolder1  $default_folder/efgh
 }}} 
-which means that {{{subfolder1}}} has the value {{{/work/abcd/efgh}}}. You can also use any variables that are already defined within the {{{palmrun}}}/{{{palmbuild}}} scripts. The most important one is {{{jobname}}}, which value is given with {{{palmrun}}} option {{{-d}}}, and which defines the so-called ''jobname''. This variable is mentioned here because it is used in the default configuration files for naming I/O files and to better sort I/O files from different PALM runs in an organized folder structure. Beside the value replacement using the UNIX shell syntax (i.e. {{{$abcd}}} gives the value of variable {{{abcd}}}), another way to insert values of environment variables is to write them in double curly brackets, i.e. {{{ {{abcd}} }}} will be replaced by the value of {{{abce}}}. This way of variable replacement is required for some special variables and in the job directives.
+  which means that {{{subfolder1}}} has the value {{{/work/abcd/efgh}}}. You can also use any variables that are already defined within the {{{palmrun}}}/{{{palmbuild}}} scripts. The most important one is {{{jobname}}}, which value is given with {{{palmrun}}} option {{{-d}}}, and which defines the so-called ''jobname''. This variable is mentioned here because it is used in the default configuration files for naming I/O files and to better sort I/O files from different PALM runs in an organized folder structure. Beside the value replacement using the UNIX shell syntax (i.e. {{{$abcd}}} gives the value of variable {{{abcd}}}), another way to insert values of environment variables is to write them in double curly brackets, i.e. {{{ {{abcd}} }}} will be replaced by the value of {{{abce}}}. This way of variable replacement is required for some special variables and in the job directives.
+
 * lines starting with {{{IC:}}} define any unix commands that are executed by {{{palmrun}}} just before the PALM code is started. A typical input command might be
 {{{
 IC:ulimit -s unlimited
 }}}
-to increase the system's stack size (if this is not unlimited by default), which is required for PALM runs with larger memory demands.
+  to increase the system's stack size (if this is not unlimited by default), which is required for PALM runs with larger memory demands.
+
 * lines starting with {{{OC:}}} define unix commands that are executed by {{{palmrun}}} just after the PALM code has stopped. For example, you may inform yourself about termination of the program by sending an email:
 {{{
 OC:echo "PALM simulation $jobname has finished" | mailx  username@email-address
 }}}
+
 * lines starting with {{{EC:}}} define unix commands that shall be executed in case that the PALM code or the {{{palmrun}}} script terminated because of any kind of error. You can restrict execution of error commands to specific kinds of error:
 {{{
 EC:[[     ]]  &&  error-command
 }}}
+
 * lines starting with {{{BD:}}} define directives that are required for batch jobs, i.e. if PALM shall be run in batch mode. Explanations for batch directives are given further below.
+
 * lines starting with {{{BDT:}}} define directives for an additional batch job that is required in case of running PALM in batch mode on a remote host. This additional job transfers the job protocol file of the main PALM job back to the local host.