Changes between Version 2 and Version 3 of doc/app/palm_config

Timestamp:

May 24, 2018 4:09:47 PM (7 years ago)

Author:

raasch

Comment:

--

doc/app/palm_config

@@ -18 +18 @@
 If PALM has been successfully installed by the automatic installer, the installer creates a configuration file named {{{.palm.config.default}}} in the working directory of the user (which by default is assumed to be {{{$HOME/palm/current_version}}}). This file should contain all relevant information to run PALM on the respective computer.
 
-The installer may fail for various reasons, e.g. because of mismatches in the user's system configuration. Problems may appear if the user has installed more than one FORTRAN compiler, and/or if the netCDF libraries have been generated with a different compiler than is used for compiling PALM. Furthermore, the automatic installer cannot be used on many larger computer systems where software (compilers, libraries) is managed via the {{{module}}} environment. In all these cases, the user has to setup the configuration file manually.
+The installer may fail for various reasons, e.g. because of mismatches in the user's system configuration. Problems may appear if the user has installed more than one FORTRAN compiler, and/or if the netCDF libraries have been generated with a different compiler than is used for compiling PALM. Furthermore, the automatic installer cannot be used on many larger computer systems where software (compilers, libraries) is managed via the {{{module}}} environment, or if you like to run batch jobs an a remote host. In all these cases, the user has to setup the configuration file manually.
 
 
@@ -28 +28 @@
   cp trunk/SCRIPTS/.palm.config.default .
 }}}
+
+The configuration file is an ASCII file which you can open with any editor. The format of the file is simple:
+
+* lines starting with a {{{#}}} in the first column are comment lines
+{{{
+# this is a comment line
+}}}
+* lines starting with a {{{%}}} in the first column are defining unix environment varibales used in {{{palmrun}}} and {{{palmbuild}}}.
+{{{
+%var value of var
+}}}
+means that a variable named {{{var}}} is created which is given the value {{{value of var}}}. 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. 
+