WikiPrint - from Polar Technologies

Install a configuration

Download a model configuration to a specific machine using the modipsl tool.

1. Description

modipsl is a suite of scripts which allow you to

obtain a model configuration from a computing center;
to compile the model components of a model configuration on a specific machine.

modipsl is also the architecture hosting the models and tools of a chosen model configuration. modipsl is developed at IPSL.

2. Downloading modipsl

svn co --username icmc_users https://forge.ipsl.fr/igcmg/svn/modipsl/trunk modipsl

The password must be asked a Platform group member. To avoid typing this command line for every new modipsl retrieval, we recommend to create an alias :

alias svn_ano='svn co --username icmc_users https://forge.ipsl.fr/igcmg/svn/modipsl/trunk modipsl'

The retrieval command then becomes

svn_ano

To learn more about SVN and other useful scripts, click here.

3. How to use modipsl

3.1. The modipsl directories

After downloading modipsl, you should have the following directory structure:

util contains information and scripts necessary to setup the different versions of the IPSL models;

doc contains the CECILL's license (license of the IPSL models)

modipsl also contains the following directories (empty at the beginning) :

modeles: directories containing the model source codes (filled once the model configuration has been downloaded and unpacked)

config: directories containing the experiment directories (filled once the model configuration has been downloaded and unpacked: with command: ./model config_name)

bin: directory containing the executables (filled after compiling)

lib and tmp: directories containing temporary files created during the compilation. Those directories will not be used by all models.

Main scripts in the directory util

model --> Downloading script for available model configurations. This script also provides information on the available model configurations.

mod.def --> File containing the information on the available model configurations : components, tags, svn servers

ins_make --> Install Makefiles for the computing machine

3.2. Available configurations via modipsl

Using modipsl will give you access to a large number of model configurations, each of them uses one or more IPSL models. To list the available model configurations, use the following script:

cd modipsl/util
./model -h

To obtain information on the models used (tags, versions,...) in a specific configuration, use the following script:

./model -h config_name

Example with IPSLCM7.0 :

./model -h IPSLCM7.0
 


model : IPSLCM7.0
 
IPSLCM7.0 1st coupled configuration in CM7 family
With this configuration icosa grid or reg grid can be used (user choice)
IPSLCM7 can be use in full coupled configuration or with forced subconfiguration
Regular subconfiguration (without ocean) give same results than with IPSLCM6.2.4
NEMO v4.2.2
XIOS2 trunk revision 2626
IOIPSL tags v2_2_5
DYNAMICO master 73d9b2d9
ICOSA_LMDZ rev 4858
LMDZ6 trunk revision 4938
ORCHIDEE_2_2 default : branches/ORCHIDEE_2_2 revision 8572
ORCHIDEE_4 optional : trunk revision 8571
INCA6 trunk revison 1151
OASIS3-MCT 2.0_branch (rev 1818 Cerfacs server, rev 6331 IPSL server)
CONFIG/IPSLCM7 rev 6881
libIGCM trunk rev 1659
 
model manager email address : platform-extract@listes.ipsl.fr
 
(...)

If the requested model configuration does not exist :

 ./model -h IPSLCM7.toto
Model IPSLCM7.toto unknown
Try "model -h"

3.3. How to download and use a selected model configuration

Downloading is the recovery of the source codes of the model components of a specific model configuration from different SVN servers. The download can be done with this script:

./model config_name

When you try to access to the component servers, some of them request a login and a password: ORCHIDEE, NEMO, INCA and REPROBUS. To do so, you must contact the person in charge of the model configuration (see above the list of special cases; model managers email addresses is available via the command model -h)

Example :

cd modipsl/util
# see all the available configurations
./model -h
# extract the IPSLCM7.0 configuration  
./model IPSLCM7.0

The source codes of the downloaded models are in the modipsl/modeles/ directory.

For the previous example you will obtain the following directories :

modipsl/modeles/IOIPSL
modipsl/modeles/LMDZ
modipsl/modeles/ORCHIDEE
modipsl/modeles/XIOS

Coupled configuration will download the coupler directyl in modipsl/oasic-mct

modipsl also installs a model configuration. It is installed in the directory modipsl/config (here modipsl/config/IPSLCM7).
Each model will be compiled and the simulation will be run in the config directory.

The log files of the installation are stored in the modipsl/util/log file.

3.3.1. v7 family

Configuration management in mod.def has evolved with v7 configurations. Until now, all forced and coupled configurations were explicitly described in mod.def (e.g. IPSLCM6.2.2, LMDZOR_v6.2.2, etc.). From v7 onwards, only the IPSLCM7 coupled configuration is offered in mod.def, from which you can choose the sub-configuration you wish to extract.

./model IPSLCM7*** [subconfig]

e.g. 

./model IPSLCM7.0 ICOLMDZORINCA

You can choose to extract the entire IPSLCM7 configuration, enabling you to use all the sub-configurations included in this model (IPSLCM7-ico, IPSLCM7-reg, IPSLESM-ico, IPSLESM-reg, ICOLMDZOR, LMDZOR, ICOLMDZORINCA, LMDZORINCA) with a single executable.

3.4. Syntax in mod.def

The file mod.def contains a section per predefined configuration. Each section must contain one or several lines starting with:

#-H- config_name Text information describing the configuration, character string, can contain space as well
#-C- config_name One line per code to extract, see syntax below

As optional in mod.def, lines starting with #-M- config_name will specify a different email adress used to send a mail only at first extraction at a new machine for a specific login.

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 address 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 latest revision 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- 7 svn http://forge.ipsl.fr/nemo/svn
#-S- 8 svn --username icmc_users https://forge.ipsl.fr/igcmg/svn
#-S- 9 svn --username inca https://forge.ipsl.fr/inca/svn
#-S- 10 svn --username icmc_users https://forge.ipsl.fr/libigcm/svn
#-S- 12 svn https://forge.ipsl.fr/ioserver/svn
#-S- 13 svn https://forge.ipsl.fr/fcm/svn
#-S- 14 svn svn://forge.ipsl.fr/orchidee
#-S- 15 svn https://oasis3mct.cerfacs.fr/svn
#-S- 16 svn --username reprobus https://forge.ipsl.fr/lmdz-reprobus/svn
#-S- 17 svn https://forge.ipsl.fr/shaconemo/svn
#-S- 18 svn https://forge.ipsl.fr/dynamico/svn/codes
#-S- 19 svn https://forge.ipsl.fr/heat/svn/codes/dynamico_lmdz
#-S- 20 svn https://svn.lmd.jussieu.fr/LMDZ
#-S- 21 git https://gitlab.in2p3.fr/ipsl/projets/dynamico/dynamico.git
#-S- 22 git https://forge.nemo-ocean.eu/nemo/nemo.git
#-S- 23 git https://gitlab.in2p3.fr/pisco/pisces-gas/pisces-gas_v4.2.1.git
#---------------------------------------------------------------------

...
#---- IPSLCM configurations

#-C- IPSLCM7.0  master                                           73d9b2d9    21   DYNAMICO       modeles   DYNAMICO
#-C- IPSLCM7.0  ICOSA_LMDZ                                       4897        20   ICOSA_LMDZ     modeles   DYNAMICO
#-C- IPSLCM7.0  IOIPSL/tags/v2_2_5                               6644         8   IOIPSL         modeles   IOIPSL
#-C- IPSLCM7.0  branches/ORCHIDEE_2_2/ORCHIDEE                   8572        14   ORCHIDEE_2_2   modeles   ORCHIDEE
#-C- IPSLCM7.0  trunk/ORCHIDEE                                   8571        14   ORCHIDEE_4     modeles   ORCHIDEE
#-C- IPSLCM7.0  CPL/oasis3-mct/branches/OASIS3-MCT_5.0_branch    6331         8   oasis3-mct     .         OASIS
#-C- IPSLCM7.0  LMDZ6/trunk                                      4938        20   LMDZ           modeles   LMDZ
#-C- IPSLCM7.0  CONFIG/UNIFORM/v7/IPSLCM7                        6886         8   IPSLCM7        config    CONFIG
#-C- IPSLCM7.0  branches/ORCHIDEE_2_2/ORCHIDEE_OL                8572        14   ORCHIDEE_OL_2_2 config   ORCHIDEE
#-C- IPSLCM7.0  trunk/ORCHIDEE_OL                                8571        14   ORCHIDEE_OL_4   config   ORCHIDEE
#-C- IPSLCM7.0  trunk/libIGCM                                    1659        10   libIGCM        .         libIGCM
#-C- IPSLCM7.0  4.2.2                                            7f5d8137    22   NEMO           modeles   NEMO
#-C- IPSLCM7.0  trunk/INCA6                                      1151         9   INCA           modeles   INCA
#-C- IPSLCM7.0  XIOS2/trunk                                      2626        12   XIOS           modeles   XIOS

...

By launching ./model IPSLCM7.0, you'll install, among other things, in directory

modipsl/modeles/DYNAMICO : revision 73d9b2d9 of master on git server 21 (git https://gitlab.in2p3.fr/ipsl/projets/dynamico/dynamico.git)
modipsl/modeles/IOIPSL : revision number 6644 of IOIPSL/tags/v2_2_5 (extract with command number 8 "svn --username icmc_users https://forge.ipsl.fr/igcmg/svn")
modipsl/modeles/ORCHIDEE_2_2 : revision number 8572 of branches/ORCHIDEE_2_2 (extract with command number 14)
modipsl/modeles/ORCHIDEE_4 : revision number 8571 of trunk/ORCHIDEE
modipsl/modeles/LMDZ : revision number 4938 of LMDZ6/trunk
...

3.5. 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. You might want to use the latest version on a specific model. To find out which model version to use, please contact the model development team directly.

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.