Changes between Version 3 and Version 4 of Doc/Install

Timestamp:

03/02/15 15:20:37 (9 years ago)

Author:

jgipsl

Comment:

--

Doc/Install

@@ -170 +170 @@
 The log files of the installation are stored in the `modipsl/util/log` file.
 
+
+## Syntax in mod.def ##
+When launching '''./model config_name''', in mod.def lines starting with 
+ * '''#-H- config_name''' only text information
+ * '''#-M- config_name''' an email will be sent to the given address only at first extraction at a new machine  
+ * '''#-C- config_name''' code extraction
+
+The code extraction line has the following syntax :
+{{{
+#-C- config_name  versionOnServer      revisionNumber    depotNumber modelName    dirInModipsl
+}}}
+ * depotNumber is the reference of the repository address for the given code. The full adress is set in the beginning of mod.def where all repository addresses are listed starting with '''#-S- number'''.
+ * versionOnServer is directory to extract find on the current depository address
+ * revisionNumber is the revision to extract. If revisionNumber is HEAD, the lastest revsion on the versionOnServer will be extracted.
+ * dirInModipsl is the directory in modipsl where the code will be installed
+ * modelName is the name of the installed directory. The code will be find in modipsl/dirInModipsl/modelName
+
+As an example see here an extract from mod.def:
+{{{
+...
+#-S- 8 svn http://forge.ipsl.jussieu.fr/igcmg/svn
+#-S- 9 svn --username inca http://forge.ipsl.jussieu.fr/inca/svn
+#-S- 10 svn http://forge.ipsl.jussieu.fr/libigcm/svn
+#-S- 11 svn http://svn.lmd.jussieu.fr/LMDZ
+#-S- 12 svn http://forge.ipsl.jussieu.fr/ioserver/svn
+#-S- 13 svn http://forge.ipsl.jussieu.fr/fcm/svn
+#-S- 14 svn svn://forge.ipsl.jussieu.fr/orchidee
+...
+...
+#-H- LMDZ_v5  LMDZ (closest version to IPSLCM5_v5)
+#-H- LMDZ_v5  This configuration can be used with LMDZ4(LMDZ4/branches/LMDZ4_AR5) or LMDZ5 (LMDZ5/trunk(default), LMDZ5/branches/LMDZ5_AR5)
+#-M- LMDZ_v5  Josefine.Ghattas@ipsl.jussieu.fr
+#-C- LMDZ_v5  IOIPSL/tags/v2_2_2/src              HEAD               8  IOIPSL/src modeles
+#-C- LMDZ_v5  LMDZ5/trunk                         2076               11 LMDZ       modeles
+#-C- LMDZ_v5  CONFIG/UNIFORM/v5/LMDZ_v5           HEAD               8  LMDZ_v5    config
+#-C- LMDZ_v5  tags/libIGCM_v2.5                   HEAD               10 libIGCM    .
+...
+}}}
+By launching ./model LMDZ_v5, you'll install in directory
+ * modipsl/modeles/IOIPSL/src : the latest revision of IOIPSL/tags/v2_2_2/src from repository http://forge.ipsl.jussieu.fr/igcmg/svn
+ * modipsl/modeles/LMDZ : revision 2076 of LMDZ5/trunk from repository http://svn.lmd.jussieu.fr/LMDZ
+ * modipsl/config/LMDZ_v5 : the latest revision of CONFIG/UNIFORM/v5/LMDZ_v5 from repository http://forge.ipsl.jussieu.fr/igcmg/svn
+ * modipsl/libIGCM : the latest revision of tags/libIGCM_v2.5 from repository http://forge.ipsl.jussieu.fr/libigcm/svn
+
+
 ## Change a model version ##
 By default the available model configurations use specific model versions. But different versions of a given model can be used with a specific configuration. This is the case for the LMDZ version in the "_v5" configurations. You might want to use the latest version on an LMDZ4/branches/LMDZ4_AR5 branch (used for CMIP5 simulations) or you might want to use the new physics scheme of LMDZ and therefore you will need a more recent version of LMDZ5/trunk. To find out which model version to use, please contact the model development team directly. [[BR]]
@@ -175 +220 @@
 If you already know which model version to use, you just have to change the section about the model configuration you selected in '''modipsl/util/mod.def'''. [[BR]]
 
+For example with LMDZOR_v5, in mod.def you have the following lines:
+{{{
+#-C- LMDZOR_v5  tags/ORCHIDEE_1_9_5/ORCHIDEE          HEAD               14 ORCHIDEE   modeles
+#-C- LMDZOR_v5  LMDZ5/trunk                           2076               11 LMDZ       modeles
+}}}
+The second column tells the version and third column the revision for this version. If it says HEAD, this means the latest revision. 
+This means that you'll extract ORCHIDEE version '''tags/ORCHIDEE_1_9_5/ORCHIDEE''', HEAD means
+
 For example, to extract the LMDZOR_v5 configuration with the latest revision (HEAD) of LMDZ4_AR5, change '''mod.def''' to obtain :
 {{{
@@ -183 +236 @@
 #-C- LMDZOR_v5  LMDZ5/trunk                 1628               11 LMDZ       modeles
 }}}
+or to use the "testing" branch of LMDZ with revision 2160:
+{{{
+#-C- LMDZOR_v5  LMDZ5/branches/testing      2160               11 LMDZ       modeles
+}}}
+
+
 
 You can also change to use a different branch for a model. For example if you want to use the branch ORCHIDEE-DOFOCO in LMDZOR_v5.2 configuration, change to obtain following in mod.def:
@@ -188 +247 @@
 #-C- LMDZOR_v5.2  branches/ORCHIDEE-DOFOCO/ORCHIDEE   HEAD     14 ORCHIDEE    modeles
 }}}
+
+