Changes between Version 8 and Version 9 of doc/app/palm_config

Timestamp:

May 28, 2018 2:13:09 PM (7 years ago)

Author:

raasch

Comment:

--

doc/app/palm_config

@@ -31 +31 @@
 === Configuration file format
 
-The configuration file is an ASCII file which may be opened with any editor. The format of the file is simple:
+The configuration file is an ASCII file which may be opened with any editor. The format of the file is simple. Lines need to start either with {{{#}}}, {{{%}}}, {{{IC:}}}, {{{OC:}}}, {{{EC:}}}, {{{BD:}}}, or {{{BDT:}}}. Empty line are allowed too. 
 
 * lines starting with a {{{#}}} in the first column are comment lines
@@ -82 +82 @@
 ||fast_io_catalog   ||Path to a file system with fast discs (if available). This folder is used so store the temporary catalog generated by {{{palmrun}}} during each run. It should also be used to store large I/O files (e.g. restart data or 3D-output) in order to reduce I/O time. This variable is used in the default {{{.palm.iofiles}}} for the restart data files. The folder must be accessible from all compute nodes, i.e. it must reside in a global file system. WARNING: {{{/tmp}}} will only work on single node systems! In case of batch jobs on remote hosts, the variable refers to a folder on the remote host. The variable has no default value and must be set by the user. ||no default value || 
 ||local_jobcatalog  ||Folder on the local host to store the batch job protocols. In case of batch jobs running on remote hosts, the job protocol will be created on the {{{remote_jobcatalog}}} and then be transferred via scp to the {{{local_jobcatalog}}}. ||$HOME/job_queue ||
+||remote_jobcatalog ||In case of batch jobs running on remote hosts, the job protocol will be put in this folder, and then automatically transferred via scp to the {{{local_jobcatalog}}}. The transfer is done by a separate small batch job, which directives are defined by the {{{BDT:}}} lines. The variable has no default value and must be set by the user. Absolute paths need to be given. Using {{{$HOME}}} is not allowed / does not work. ||no default value ||
+||local_ip          ||IP-address of your local computer / the computer on which you call the {{{palmrun}}}/{{{palmbuild}}} command. You may use {{{127.0.0.0}}} if you are running PALM in interactive mode or in batch mode on your local computer. The address is only used to identify where to send the output data in case of batch jobs on a remote host. ||no default value ||
 
 
 
-
-
-# folder for job protocols to be used on the remote host
-#%remote_jobcatalog   <path/to/directory on remote host>
-
-# local ip of your computer. Use 127.0.0.0 if you are running PALM
-# in interactive mode on your local computer
-%local_ip            <replace by your computers IP address>
 
 # your local UNIX username