Changes between Version 4 and Version 5 of doc/install/simple


Ignore:
Timestamp:
Mar 5, 2018 3:29:56 PM (7 years ago)
Author:
knoop
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • doc/install/simple

    v4 v5  
    3030  palm_simple_build -b <build-config>
    3131}}}
    32 {{{<build-config>}}} has to re replaced by the suffix of any file in [source:palm/trunk/INSTALL INSTALL directory] that starts with "MAKE.inc." and contains compiler options and library paths appropriate for your system. You can find some tested and verified files with compiler-option sets in the [source:palm/trunk/INSTALL INSTALL directory] of the repository. If no one of these sets satisfies your requirements, just choose anyone and modify it in a later step (see below). The script copies the PALM source code as well as the file with this set of compiler options into a new directory {{{BUILD_<build-config>}}} and calls {{{make}}} to compile the code. \\\\
     32{{{<build-config>}}} has to re replaced by the suffix of any file in [source:palm/trunk/INSTALL INSTALL directory] that starts with {{{MAKE.inc.}}} and contains compiler options and library paths appropriate for your system. You can find some tested and verified files with compiler-option sets in the [source:palm/trunk/INSTALL INSTALL directory] of the repository. If no one of these sets satisfies your requirements, just choose anyone and modify it in a later step (see below). The script copies the PALM source code as well as the file with this set of compiler options into a new directory {{{BUILD_<build-config>}}} and calls {{{make}}} to compile the code. \\\\
    3333
    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:
     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:
    3535{{{
    3636  palm_simple_run -b <build-config> -c <run-config> -s <test-case> -p <mpi-ranks> -n <mpi-ranks-per-node> -t <openmp-threads>
     
    3838Option {{{-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.
    3939
    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>}}}. \\\\
     40After the run has finished, all OUTPUT files can be found in directory {{{RUN_<build-config>_<run-config>_<test-case>_<mpi-ranks>_<mpi-ranks-per-node>_<openmp-threads>}}}. \\\\
    4141'''Sixth step:''' To verify the results of this example run, compare it with the default result:
    4242{{{