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

Timestamp:

May 24, 2018 7:01:41 PM (7 years ago)

Author:

raasch

Comment:

--

doc/app/palm_config

@@ -29 +29 @@
 }}}
 
-The configuration file is an ASCII file which you can open with any editor. The format of the file is simple:
+=== Configuration file format
+
+The configuration file is an ASCII file which may be opened with any editor. The format of the file is simple:
 
 * lines starting with a {{{#}}} in the first column are comment lines
@@ -45 +47 @@
 }}} 
 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 ... 
+* 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.
+* 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.
 
 
+=== environment variables and their meaning
 
+The default template contains settings for the minimum set of variables that always need to be defined, plus suggestions for other variables that you may need to uncomment, in case that you like/need to use them. The following table lists all relevant variables and their meaning.
+
+| Name | meaning |
+
+
+=== batch job directives
+