Changes between Version 13 and Version 14 of doc/app/palm_config


Ignore:
Timestamp:
Aug 15, 2018 2:46:49 PM (6 years ago)
Author:
raasch
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • doc/app/palm_config

    v13 v14  
    9494||compiler_name_ser ||FORTRAN compiler name to create non-MPI executables. This name is required, because {{{palmbuild}}} generates several helper programs for pre-/post-processing, which run in serial mode on just one code. Here you give the original compiler name, like ''ifort'', ''pgfortran'', ''gfortran'', or ''xlf95''.  ||no default value  || 
    9595||cpp_options       ||Preprocessor directives to be used for compiling the PALM code. They allow for conditional compilation using the {{{-D}}} compiler option. Compiling PALM with MPI support requires options {{{-D__parallel -DMPI_REAL=MPI_DOUBLE_PRECISION -DMPI_2REAL=MPI_2DOUBLE_PRECISION}}}. Many compilers require to set an additional option to run the FORTRAN preprocessor on source files before compilation (e.g. ''-fpp'' for the Intel compiler). This option has to be given here too. Alternatively, you can provide it as part of the {{{compiler_options}}}. See [wiki:doc/app/cpp_options cpp_options] for a complete list of preprocessor define strings that are used in the PALM code.  ||no default value  ||
    96 ||make_options      ||Options for the UNIX {{{make}}}-command, which is used by {{{palmbuild}}} to compile the PALM code. In order to speed up compilation, you may use the {{{-j}}} option, which specifies the number of jobs to run simultaneously. If you have e.g. 4 cores on your local computer system, then {{{-j 4}}} starts 4 instances of the FORTRAN compiler, i.e. 4 FORTRAN-files are compiled simultaneously (if the dependencies allow for that).  ||no default value  ||
     96||make_options      ||Options for the UNIX {{{make}}}-command, which is used by {{{palmbuild}}} to compile the PALM code. In order to speed up compilation, you may use the {{{-j}}} option, which specifies the number of jobs to run simultaneously. If you have e.g. 4 cores on your local computer system, then {{{-j 4}}} starts 4 instances of the FORTRAN compiler, i.e. 4 FORTRAN-files are compiled simultaneously (if the dependencies allow for that). Do not try to start more instances than the number of available cores, because this will decrease the compiler performance significantly. ||no default value  ||
     97||compiler_options  ||Options to be used by the compiler that has been specified by {{{compiler_name}}} / {{{compiler_name_ser}}} in order to compile the PALM and utilities source code. Please see [wiki:doc/app/recommended_compiler_options] for recommended compiler options for specific compilers. Library paths do not have to be given here (although you can do that), but paths to INCLUDE files may need to be specified.  ||no default value  ||
     98||linker_options    ||Compiler options to be used to link the PALM executable. Typically, these are paths to libraries used by PALM, e.g. NetCDF, FFTW, MPI, etc. You may repeat the options that you have given with {{{compiler_options}}} here. See your local system documentation / software manuals for required path settings. Requirements differ from system to system and also depend on the respective libraries that you are using. See [wiki:doc/app/recommended_compiler_options] for specific path settings that we, the PALM group, are using on our computers.  Be aware, that these settings probably will not work on your computer system.  ||no default value  ||
     99||'''hostfile'''          ||'''Name of the hostfile that is used by MPI to determine the nodes on which the MPI processes are started.'''\\\\ {{{palmrun}}} automatically generates the hostfile if you set {{{auto}}}. All MPI processes will then be started on the node on which {{{palmrun}}} is executed. The real name of the hostfile will then be set to {{{hostfile}}} (instead of {{{auto}}}) and, depending on your local MPI implementation, you may have to give this name in the {{{execute_command}}}. MPI implementations on large computer centers often do not require to explicitly specify a hostfile (in such a case you can remove this line from the configuration file), or the batch systems provides a hostfile which name you may access via environment variables (e.g. {{{$PBS_NODEFILE}}}) and which needs to be given in the {{{execute_command}}}. Please see your local system / batch system documentation about the hostfile policy on your system.  ||no default value  ||
     100||execute_command   ||MPI command to start the PALM executable. \\  Please see your local MPI documentation about which command needs to be used on your system. The name of the PALM executable, usually the last argument of the execute command, must be {{{palm}}}. Typically, the command requires to give several further options like the number of MPI processes to be started, or the number of compute nodes to be used. Values of these options may change from run to run. Don't give specific values here and use variables instead which will be automatically replaced by {{{palmrun}}} with values that you have specified with respective {{{palmrun}}} options. As an example {{{aprun  -n {{mpi_tasks}}  -N {{tasks_per_node}}  palm}}} will be interpreted as {{{aprun  -n 240  -N 24  palm}}} if you call {{{palmrun ... -X240 -T24 ...}}}.  ||no default value  ||
    97101
    98 
    99 # options to be used to compile PALM
    100 %compiler_options    -openmp -fpe0 -O3 -xHost -fp-model source -ftz -fno-alias -no-prec-div -no-prec-sqrt -ip -nbs -I /muksoft/packages/fftw/3.3.4/include -L/muksoft/packages/fftw/3.3.4/lib64 -lfftw3 -I /muksoft/packages/netcdf/4_intel/include -L/muksoft/packages/netcdf/4_intel/lib -lnetcdf -lnetcdff
    101 
    102 # options to be used to link the PALM executable
    103 %linker_options      -openmp -fpe0 -O3 -xHost -fp-model source -ftz -fno-alias -no-prec-div -no-prec-sqrt -ip -nbs -I /muksoft/packages/fftw/3.3.4/include -L/muksoft/packages/fftw/3.3.4/lib64 -lfftw3 -I /muksoft/packages/netcdf/4_intel/include -L/muksoft/packages/netcdf/4_intel/lib -lnetcdf -lnetcdff
    104 
    105 # name of hostfile to be used
    106 %hostfile            auto
    107 
    108 # command to start the PALM executable
    109 %execute_command     mpiexec  -machinefile hostfile  -n {{mpi_tasks}}  palm
    110102
    111103# memory request per core