Changes between Version 29 and Version 30 of doc/install

Timestamp:

Sep 15, 2010 9:54:12 AM (14 years ago)

Author:

witha

Comment:

--

doc/install

@@ -212 +212 @@
 You will be prompted for your password. After completion, a subdirectory trunk will appear in your working directory. It contains a number of further subdirectories, which contain e.g. the PALM source code ({{{SOURCE}}}) and the scripts for running PALM ({{{SCRIPTS}}}). For checking out the most recent PALM version (developer version), see the [#advanced advanced installation method] described above.\\\\
 Please never touch any file in your working copy of PALM, unless you really know what you are doing.
+
+=== Configuration and compilation ===
+
+'''Third step:''' To use the PALM scripts, the {{{PATH}}}-variable has to be extended and the environment variable {{{PALM_BIN}}} has to be set. For convenience, setting should be done in the respective profile of the users default shell (e.g. in {{{.profile}}}, if {{{ksh}}} is used):
+{{{
+  export PALM_BIN=$HOME/palm/current_version/trunk/SCRIPTS
+  export PATH=$PALM_BIN:$PATH
+}}}
+You may have to login again in order to activate the profile settings.\\\\
+'''Fourth step:''' Call the installation script:
+{{{
+  palm_simple_install -i MAKE.inc.ifort.imuk
+}}}
+The script copies the PALM source code into a new subdirectory {{{MAKE_DEPOSITORY_simple}}}. This directory also will contain a {{{Makefile}}} and an include file {{{MAKE.inc}}} to be used for compiling the code in the next step. The include file contains compiler name, compiler options, library path for netCDF, etc. '''Please adjust these settings as required by your system, before you proceed with the next step.''' The default settings in {{{MAKE.inc}}} are for the Intel-FORTRAN compiler in the IMUK environment. You may find default settings for other compilers and environments in {{{.../trunk/INSTALL/}}} See for files {{{MAKE.inc.*}}}.
+{{{
+  cd MAKE_DEPOSITORY_simple
+  make
+  cd ..
+}}}
+In order to shorten compilation time, you can run make in parallel, e.g. {{{make -j 4}}} runs 4 compile threads simultaneously.\\\\
+'''Fifth step:''' Carry out a test run in order to check the installation. The test run (as every PALM run) requires a parameter file for steering PALM, which is in FORTRAN-NAMELIST format. This file has been already generated by the installation script '''palm_simple_install''' under {{{JOBS/example_cbl/INPUT/example_cbl_p3d}}}. PALM is started with script '''palm_simple_run'''. '''Before''' the first run, it may be necessary to change the MPI-execution command ({{{mpiexec}}}, {{{mpirun}}}, etc.) and options in this script, depending on the MPI-library that you are using. The script can be found in directory {{{.../trunk/SCRIPTS}}}. Default settings in this script are for the SGI-mpt-library installed on HLRN. You will find the execution command almost at the end of this script. After having adjusted the MPI-execution command, start the run with:
+{{{
+  palm_simple_run -p 4 -n 4 -c example_cbl
+}}}
+where option {{{-p}}} gives the total number of MPI tasks, {{{-n}}} gives the number of MPI tasks per node, and {{{-c}}} gives the parameter file to be used.\\
+After the run has finished, all OUTPUT files can be found in directory {{{OUTPUT...}}}. Names and contents of PALM output files are described in [../chapter_3_4 chapter 3.4]. The directory name is composed of the parameter file name, the number of cores that have been used, and the current data and time. For every run a unique directory is created.\\\\
+'''Sixth step:''' To verify the results of this example run, compare it with the default result:
+{{{
+diff  OUTPUT..../RUN_CONTROL   trunk/INSTALL/example_cbl_rc
+}}}
+'''You should not find any difference between these two files,''' except of the run date and time displayed at the top of the file header, and, maybe, the number of cores that have been used. If the file contents are identical, the installation is successfully completed.