Changes between Version 21 and Version 22 of doc/install

Timestamp:

Sep 15, 2010 9:05:58 AM (14 years ago)

Author:

witha

Comment:

--

doc/install

@@ -67 +67 @@
 }}}
 This version may contain new features (they might not be documented well), but it may also contain bugs.
+
+=== Package Configuration ===
+
+To use the PALM scripts, the {{{PATH}}}-variable has to be extended and the environment variable {{{PALM_BIN}}} has to be set (on local and remote host) in the respective profile of the users default shell (e.g. in {{{.profile}}}, if {{{ksh}}} is used):
+{{{
+  export PATH=$HOME/palm/current_version/trunk/SCRIPTS:$PATH
+  export PALM_BIN=$HOME/palm/current_version/trunk/SCRIPTS
+}}}
+You may have to login again in order to activate these settings.\\\\
+On the local and on the remote host, some small helper/utility programs have to be installed, which are later used by '''mrun''' e.g. for PALM data postprocessing. The installation is done by '''mbuild'''. This script requires a configuration file {{{.mrun.config}}}, which will be also used by '''mrun''' in the following. A copy has to be put into the working directory under the name {{{.mrun.config}}} by
+{{{
+  cp trunk/SCRIPTS/.mrun.config.default .mrun.config
+}}}
+Beside many other things, this file contains typical installation parameters like compiler name, compiler options, etc. for a set of different (remote) hosts. Please edit this file, uncomment lines like
+{{{
+  #%remote_username  <replace by your ... username>   <host identifier>
+}}}
+by removing the first hash (#) character and replace the string "{{{<replace by ...>}}}" by your username on the respective host given in the {{{<host identifier>}}}. You only have to uncomment lines for those hosts on which you intend to use PALM.\\\\
+'''Warning: When editing the configuration file, please NEVER use the TAB key. Otherwise, very confusing errors may occur when mrun is executing.'''\\\\
+Beside the default configuration file {{{.mrun.config.default}}}, the directory {{{trunk/SCRIPTS}}} contains additional configuration files which are already adjusted for special hosts, e.g. {{{.mrun.config.imuk}}} can be used at Hannover University, etc.. These files have to be edited in the same way as described above.\\\\
+After modifying the configuration file, the respective executables are generated by executing
+{{{
+  mbuild -u -h lcmuk
+  mbuild -u -h lcsgih
+}}}
+The second call also copies the PALM scripts (like '''mrun''' and '''mbuild''') to the remote host.