Changes between Version 18 and Version 19 of doc/install/advanced
- Timestamp:
- Sep 27, 2021 3:50:02 PM (4 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
doc/install/advanced
v18 v19 7 7 '''Before you start, please check if you have fulfilled all [wiki:doc/install#Softwarerequirements installation requirements!]''' 8 8 9 The install script that comes with the PALM Model System normally cares for steps 1-5 that are described below. Failure of the installation process is usually caused by inconsistencies in your software environment (e.g. mismatches between your compiler, NetCDF- and MPI- libraries) which will also cause failure of the manual installation. Anyhow, at least parts of the installation steps may be required to be carried out manually.9 Before you continue with manual configuration, please follow the steps for the installation as described in the README.md file that comes with the PALM Model System. The install script that comes with the PALM Model System normally cares for steps 1-5 that are described below. Failure of the installation process is usually caused by inconsistencies in your software environment (e.g. mismatches between your compiler, NetCDF- and MPI- libraries) which will also cause failure of the manual installation. Anyhow, upon failure of the install script, at least parts of the installation steps may be required to be carried out manually. 10 10 11 11 Installation and configuration for batch jobs cannot be done by the install script and requires manual work in any case, as described further below. … … 27 27 == [=#package_configuration]Third step: Package configuration == 28 28 29 Compilation and execution of PALM is mainly controlled by two shell scripts named [wiki:doc/app/palmbuild {{{palmbuild}}}] and [wiki:doc/app/palmrun {{{palmrun}] that are part of the download and reside in folder [source:palm/trunk/SCRIPTS SCRIPTS]. To use these scripts, you need to extend your {{{PATH}}}-variable, by adding a line 30 {{{ 31 export PATH=$HOME/palm/current_version/trunk/SCRIPTS:$PATH 32 33 }}} 34 in your {{{.bashrc}}} file. The change will be active in any newly opened terminal. You need to enter 35 {{{ 36 source $HOME/.bashrc 37 }}} 38 in order to activate it in your existing terminal session. 29 Compilation and execution of PALM is mainly controlled by two shell scripts named [wiki:doc/app/palmbuild palmbuild] and [wiki:doc/app/palmrun palmrun] that are part of the download. 39 30 40 {{{palmbuild}}} as well as {{{palmrun}}} are controlled by options as well as settings in the main configuration file that is expected to be in your working directory. You can get a defaultversion of this file from the repository:31 {{{palmbuild}}} as well as {{{palmrun}}} are controlled by options as well as settings in the main configuration file that is expected to be in your working directory. You can get a preconfigured version of this file from the repository: 41 32 {{{ 42 33 cd ~/palm/current_version 43 cp trunk/SCRIPTS/.palm.config.default .palm.config.default34 cp palm_model_system/packages/palm/model/share/config/.palm.config.default .palm.config.default 44 35 }}} 45 36 The string after the last dot (here {{{default}}}) is the so-called ''configuration identifier'' which you can freely choose. As default, the scripts expect the configuration identifier {{{default}}}. … … 49 40 '''Warning: When editing the configuration file, please NEVER use the {{{TAB}}} key. Otherwise, the scripts may run into very confusing errors.''' 50 41 51 Beside the default configuration files {{{.palm.config.default}}}, folder {{{ trunk/SCRIPTS}}} contains additional configuration files which are already adjusted for specific environments, e.g. {{{.palm.config.crayh}}} can be used for a Cray-System at [https://www.hlrn.de HLRN], etc.. These files have to be edited in the same way as described above. \\\\42 Beside the default configuration files {{{.palm.config.default}}}, folder {{{palm_model_system/packages/palm/model/share/config/}}} contains additional configuration files which are already adjusted for specific environments, e.g. {{{.palm.config.crayh}}} can be used for a Cray-System at [https://www.hlrn.de HLRN], etc.. These files have to be edited in the same way as described above. \\\\ 52 43 53 44 … … 62 53 Option {{{-c default}}} can be omitted, because {{{default}}} is the default. 63 54 64 {{{palmbuild}}} will prompt some queries, which must all be answered "y". Depending on which compiler optimization options have been set in the configuration file, compilations may take up to 10 minutes. {{{palmbuild}}} is using the ''make'' mechanism. Dependencies are described in a [source:palm/trunk/SOURCE/Makefile Makefile]. {{{palmbuild}}} creates a folder {{{MAKE_DEPOSITORY_<configuration identifier>}}} in your working directory (in the default case it is {{{MAKE_DEPOSITORY_default}}}.\\\\55 {{{palmbuild}}} will prompt some queries, which must all be answered "y". Depending on which compiler optimization options have been set in the configuration file, compilations may take up to 10 minutes. {{{palmbuild}}} is using the ''make'' mechanism. Dependencies are described in a {{{Makefile}}}. {{{palmbuild}}} creates a folder {{{MAKE_DEPOSITORY_<configuration identifier>}}} in your working directory (in the default case it is {{{MAKE_DEPOSITORY_default}}}.\\\\ 65 56 66 57 … … 72 63 cd ~/palm/current_version 73 64 mkdir -p JOBS/example_cbl/INPUT 74 cp trunk/TESTS/cases/example_cbl/INPUT/example_cbl_p3d JOBS/example_cbl/INPUT/example_cbl_p3d65 cp palm_model_system/packages/palm/model/tests/cases/example_cbl/INPUT/example_cbl_p3d JOBS/example_cbl/INPUT/example_cbl_p3d 75 66 }}} 76 67 Here, the string {{{example_cbl}}} acts as the so-called ''run identifier''. … … 83 74 ~/palm/current_version/JOBS/example_cbl/MONITORING/example_cbl_rc 84 75 }}} 85 with those of the example result file that is provided under {{{ trunk/TESTS/cases/example_cbl/MONITORING/example_cbl_rc}}}, e.g. by using the standard {{{diff}}} command76 with those of the example result file that is provided under {{{palm_model_system/packages/palm/model/tests/cases/example_cbl/MONITORING/example_cbl_rc}}}, e.g. by using the standard {{{diff}}} command 86 77 {{{ 87 78 cd ~/palm/current_version 88 diff JOBS/example_cbl/MONITORING/example_cbl_rc trunk/TESTS/cases/example_cbl/MONITORING//example_cbl_rc79 diff JOBS/example_cbl/MONITORING/example_cbl_rc palm_model_system/packages/palm/model/tests/cases/example_cbl/MONITORING//example_cbl_rc 89 80 }}} 90 81 '''You should not find any difference between these two files if you are using the latest PALM revision''', except for the run date and time displayed at the top of the file header. If the file contents are identical, the installation is successfully completed.\\\\