Changes between Version 6 and Version 7 of doc/app/palm_config

Timestamp:

May 25, 2018 8:52:05 AM (7 years ago)

Author:

raasch

Comment:

--

doc/app/palm_config

@@ -72 +72 @@
 === environment variables and their meaning
 
-The default template contains settings for the minimum set of variables that always need to be defined, plus suggestions for other variables that you may need to uncomment, in case that you like/need to use them. The following table lists all relevant variables and their meaning.
+The [source:palm/trunk/SCRIPTS/.palm.config.default default template] contains settings for the minimum set of variables that always need to be defined, plus suggestions for other variables that you may need to uncomment, in case that you like/need to use them. The following table lists all relevant variables and their meaning. Default values are either those which are set in the scripts {{{palmrun}}} and {{{palmbuild}}} or which are suggested in the template file.
 
-| Name | meaning |
+||='''Variable name''' =||='''meaning''' =||='''default value''' =||
+|-----------
+||base_directory    ||Working directory from where {{{palmrun}}} or {{{palmbuild}}} is called. This folder must contain the configuration file {{{.palm.config....}}}. ||$HOME/palm/current_version ||
+||base_data         ||Directory where the PALM I/O-files are stored. This variable is used in the file configuration file (see [source:palm/trunk/SCRIPTS/.palm.iofiles .palm.iofiles], and the [wiki:doc/app/palm_iofiles description] of this file). Since this variable is also used to determine file locations on remote hosts, it must use the {{{~}}} instead of {{{$HOME}}}. ||~/palm/current_version/JOBS ||
+||source_path       ||Path to PALM's FORTRAN source files. This is the place where the automatic installer has put the download, or which has been defined in the user's {{{svn checkout}}} command. ||$HOME/palm/current_version/trunk/SOURCE ||
+||user_source_path  ||Path to the [wiki:doc/app/userint user interface routines]. The variable {{{jobname}}} that is used in the default path is replaced by the argument given with {{{palmrun}}}-option {{{-d}}}. ||$base_directory/JOBS/$jobname/USER_CODE ||
 
+
+
+# path to file system with fast discs (if available). This folder
+# is used for temporary catalogs generated by palmrun and to store large
+# I/O files (used in .palm.iofiles). This folder must be accessible from
+# all compute nodes, i.e. it must reside in a global file system
+%fast_io_catalog   <replace by a folder name which allows for fast I/O>
+
+# folder for job protocols
+#%local_jobcatalog    $HOME/job_queue
+
+# folder for job protocols to be used on the remote host
+#%remote_jobcatalog   <path/to/directory on remote host>
+
+# local ip of your computer. Use 127.0.0.0 if you are running PALM
+# in interactive mode on your local computer
+%local_ip            <replace by your computers IP address>
+
+# your local UNIX username
+%local_username      <replace by your unix username>
+
+# ip address of the remote host
+#%remote_ip           <ip>
+
+# username on the remote host
+#%remote_username     <username>
+
+# ssh-key to be used for ssh/scp calls to the remote host
+#%ssh_key             ~/.ssh/id_rsa
+
+# name of login-node on the remote machine
+#%remote_loginnode    <loginnode>
+
+# default queue to be used if palmrun-option -q is omitted
+#%defaultqueue        <queue>
+
+# command to submit batch jobs
+#%submit_command      /opt/moab/default/bin/msub -E
+
+# compilername to generate MPI executables
+%compiler_name       mpif90
+
+# compilername to generate non-MPI executables running on one core
+%compiler_name_ser   ifort
+
+# preprocessor directives to be used for compiling the PALM code
+%cpp_options         -cpp -D__parallel -DMPI_REAL=MPI_DOUBLE_PRECISION -DMPI_2REAL=MPI_2DOUBLE_PRECISION -D__fftw -D__netcdf
+
+# used for parallel compilation
+%make_options        -j 4
+
+# options to be used to compile PALM
+%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
+
+# options to be used to link the PALM executable
+%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
+
+# name of hostfile to be used
+%hostfile            auto
+
+# command to start the PALM executable
+%execute_command     mpiexec  -machinefile hostfile  -n {{mpi_tasks}}  palm
+
+# memory request per core
+#%memory              2300
+
+# module commands to load required libraries
+#%module_commands     module load fftw cray-hdf5-parallel cray-netcdf-hdf5parallel
+
+# special commands to be carried out at login and start of batch jobs on the remote host
+#%login_init_cmd      module switch craype-ivybridge craype-haswell
 
 === batch job directives