| 12 | | You can freely choose the directory name, but if you intend to switch to the [wiki:doc/install/advanced advanced method] of running PALM later, you should use {{{~/palm/current_version}}}. This directory will be called working directory from now on. '''All commands listed below have to be run from this working directory unless otherwise specified.'''\\\\ |
| 13 | | '''Second step:''' Check out a working copy of the recent PALM version from the svn-repository. Replace {{{<your username>}}} by your valid repository username, and {{{<#>}}} by any of the available PALM releases, e.g. "''3.9''" (new releases will be announced to members of the PALM mailing list). |
| | 12 | You can freely choose the directory name, but if you intend to switch to the [wiki:doc/install/advanced advanced method] of running PALM later, you should use {{{~/palm/current_version}}}. This directory will be called working directory from now on. \\\\ |
| | 13 | '''Second step:''' Check out a working copy of the recent PALM version from the svn-repository. Replace {{{<your username>}}} by your valid repository username. |
| 18 | | 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 [wiki:doc/install/advanced advanced installation method].\\\\ |
| 19 | | Please never touch any file in your working copy of PALM, unless you really know what you are doing.\\\\ |
| | 18 | 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}}}).\\\\ |
| | 19 | Please never touch any file in your working copy of PALM, except for the configuration files described later in this installation instruction.\\\\ |
| 35 | | This directory will then 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. '''If necessary, please adjust these settings in file {{{MAKE.inc}}} as required by your system, before you proceed with the next step.''' You probably will have to adjust at least the paths to the netCDF- and MPI-library on your respective system (arguments of Options {{{-L}}} and {{{-I}}}). '''This, of course, requires that you have already installed netCDF and MPI on your system (see [wiki:doc/install#requirements requirements]).''' |
| | 34 | '''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. Some test setup files can be found inside the [source:palm/trunk/INSTALL INSTALL directory]. The carry the sufix {{{_p3d}}}. PALM is started with script '''palm_simple_run'''. Similar to the build configuration files there are also some pre-configured execution configuration files in the [source:palm/trunk/INSTALL INSTALL directory]. They start with "RUN.cmd." and end with an arbitrary suffix <run-config> and contain the MPI-execution command ({{{mpiexec}}}, {{{mpirun}}}, etc.) which depend on the MPI-library that you are using and the computer you are working on. After having adjusted the MPI-execution command to your needs, start the run with: |
| 41 | | In order to speed up compilation time, you can run make in parallel, e.g. {{{make -j 4}}} runs 4 compile threads simultaneously.\\\\ |
| 42 | | '''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: |
| 43 | | {{{ |
| 44 | | palm_simple_run -p 4 -n 4 -c example_cbl -e <execution-command> |
| 45 | | }}} |
| 46 | | where option {{{-p}}} gives the total number of MPI tasks, {{{-n}}} gives the number of MPI tasks per node, {{{-c}}} gives the parameter file to be used, and {{{-e}}} defines the execution command to be used to run the PALM executable. '''Note that this command also has to be run from your working directory (e.g. {{{~/palm/current_version}}}).''' You can choose from a number of different execution commands (see at the end of the script [source:palm/trunk/SCRIPTS/palm_simple_run palm_simple_run]), but you will probably have to modify them or oven add your own command to the script, since the mpiexec syntax differs a lot among the different MPI libraries. Example: if you want to do a run on the SGI-ICE system of HLRN with the SGI-mpt-environment, you can just use {{{-e sgi-mpt}}}.\\ |
| 47 | | After the run has finished, all OUTPUT files can be found in directory {{{OUTPUT...}}}. Names and contents of PALM output files are described [../app/iofiles here]. 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.\\\\ |
| | 38 | Option {{{-s}}} gives the parameter file (test-case) to be used. Additionally, option {{{-p}}} gives the total number of MPI ranks, {{{-n}}} gives the number of MPI ranks per node and {{{-t}}} gives the number of OpenMP threads. |
| | 39 | |
| | 40 | After the run has finished, all OUTPUT files can be found in directory {{{BUILD_<build-config>_<run-config>_<test-case>_<mpi-ranks>_<mpi-ranks-per-node>_<openmp-threads>}}}. \\\\ |
