LMDZ Setup : Différence entre versions
((WIP) Add information regarding new LMDZ_Setup) |
|||
Ligne 46 : | Ligne 46 : | ||
A configuration with '''isotopes''' is also available since 2023-04. | A configuration with '''isotopes''' is also available since 2023-04. | ||
+ | |||
+ | ---- | ||
+ | |||
+ | |||
+ | == WIP - Migration de LMDZ_Setup_HowTo + inclusion nouveau LMDZ_Setup == | ||
+ | |||
+ | ''Old documentation (French): [https://docs.google.com/document/d/1OLZG6e-86NiXuv5-aALxKIh-QPkp4BdCwWtiBFot-6c LMDZ_Setup_HowTo]'' | ||
+ | |||
+ | === Downloading LMDZ_Setup === | ||
+ | |||
+ | * ''(recommended)'' Using ''subversion'': <code>svn co https://svn.lmd.jussieu.fr/LMDZ/BOL/LMDZ_Setup</code> | ||
+ | * ''(alternative)'' <code>wget https://lmdz.lmd.jussieu.fr/pub/Training/LMDZ_Setup.tar</code> | ||
+ | * ''(deprecated)'' The old <code>tutorial_prod</code> version: <code>wget https://lmdz.lmd.jussieu.fr/pub/Training/tutorial_prod.tar</code> | ||
+ | |||
+ | === User guide === | ||
+ | |||
+ | ''' /!\ WARNING''' 06/2024 | ||
+ | The JeanZay calculator, as well as Adastra, do not allow (anymore) communication from/to $STORE for running jobs on the main computing partitions. | ||
+ | As a result, make sure to replace $STORE by $WORK in <code>lmdz_env.sh</code> wherever relevant. | ||
+ | |||
+ | '''READ comments at the top of scripts ! Often your questions are answered there.''' | ||
+ | |||
+ | ''Note'': <code>LMDZ_Setup</code> has been tested on Adastra and Spirit, and to a lesser extent on JeanZay (legacy support only). No guarantee is made on other platforms, although it should be easy to adapt it. It can also be ran locally - for expert use only. | ||
+ | |||
+ | ==== Structure ==== | ||
+ | |||
+ | Once you have downloaded <code>LMDZ_Setup</code>, you will find the following main files: | ||
+ | * <code>main.sh</code>: the main script. It contains the basic settings you will modify. | ||
+ | * <code>setup.sh</code>: this script contains the internal workings of <code>LMDZ_Setup</code>. It's where you can edit expert-level settings. | ||
+ | * <code>lmdz_env.sh</code>: this file contains platform-specific configuration, such as where to install the model, where to run the simulations, etc. | ||
+ | |||
+ | ==== How to run a simulation ==== | ||
+ | |||
+ | # '''Edit <code>lmdz_env.sh</code>.''' In <code>lmdz_env.sh</code>, in the function <code>set_env</code>, find the case corresponding to your supercomputer: <code>jean-)</code> for JeanZay, <code>spiri)</code> for Spirit, <code>adast)</code> for Adastra. Edit the variables required for your use case. All the variables are documented in the last <code>*)</code> case. In particular: | ||
+ | #* you must set <code>root_dir</code> to the path where you extracted <code>LMDZ_Setup</code>. | ||
+ | # '''Edit <code>main.sh</code>.''' In <code>main.sh</code>, edit all relevant settings. | ||
+ | # '''''[optional]'' Edit <code>setup.sh</code>.''' In <code>setup.sh</code>, in the function <code>define_expert_options</code>, edit all relevant settings. | ||
+ | # '''''[optional]'' Edit <code>DEF/*</code>.''' Edit the <code>DEF/*.def</code> or <code>DEF/XMLfiles*</code> files, such as <code>config.def</code>, to your liking. ''The options you specify in main.sh/setup.sh don't require any adjustment here; such adjustments are automatically performed at runtime.'' | ||
+ | # '''Launch <code>main.sh</code>'''. |
Version du 8 juillet 2024 à 14:12
LMDZ_Setup is a set of scripts that allows a light automatic setup of LMDZ long chained climate simulations, including the installation of the model itself.
LMDZ_Setup can only be used on the Jean-Zay computer at Idris so far.
Coming VERY soon (summer 2024) : extension to other computing centers ("spirit", adastra) and Linux PCs
Documentation (in French):
LMDZ_Setup_HowTo
To extract LMDZ_Setup :
a/ Recommended : extraction from svn repository :
svn co https://svn.lmd.jussieu.fr/LMDZ/BOL/LMDZ_Setup
b/ Download of the "tar" archive :
wget https://lmdz.lmd.jussieu.fr/pub/Training/LMDZ_Setup.tar
c/ For those used with the old name "tutorial_prod.tar" : a link with this name still exists, pointing to LMDZ_Setup.tar :
wget https://lmdz.lmd.jussieu.fr/pub/Training/tutorial_prod.tar
(Text extracted from LMDZ_Setup/README0_HowTo):
LMDZ_Setup consists in running LMDZ coupled to Orchidee for land surface (optional), but with imposed sea surface temperature.
The basic default configuration makes use of the IPSL-CM6A grid configuration and tuning, and runs a multi annual simulation on "climatological" amip sea surface temperature (with a mean annual cycle) using a calendar with 360 days.
Optionally : the configuration includes the ability to use interannually varying SST and to activate "nudging" by a reanalysis. In both cases, the calendar is then a real one. When nudging is activated, the simulation must be run on a monthly basis, while otherwise, it can be either monthly or yearly.
Since LMDZ_Setup automatically generates its own initial files, it can be run with zoom configurations by only changing the number of grid points ("resol" in main.sh) and the DEF/gcm.def file (see bellow).
Aerosols can be read for the year 2000 (weighted average over 1999-2001 cf Lurton et al 2020), and instantaneous forcing with respect to 1850 can be computed as well.
LMDZ_Setup can also run LMDZ coupled with the SPLA model (SimPLe Aerosol, activated with option aerosols=spla in setup.sh). Emissions of dust and sea salt are then computed interactively. For the time being, SPLA-specific input files (anthropic aerosol emissions)are only available on the grid zoomed over N Africa used by J. Escribano in his PhD thesis, and by B. Diallo and H. Senghor in subsequent work on N-African dust (file DEF/gcm.def_zNAfrica_BiJe).
A configuration with isotopes is also available since 2023-04.
Sommaire
WIP - Migration de LMDZ_Setup_HowTo + inclusion nouveau LMDZ_Setup
Old documentation (French): LMDZ_Setup_HowTo
Downloading LMDZ_Setup
- (recommended) Using subversion:
svn co https://svn.lmd.jussieu.fr/LMDZ/BOL/LMDZ_Setup
- (alternative)
wget https://lmdz.lmd.jussieu.fr/pub/Training/LMDZ_Setup.tar
- (deprecated) The old
tutorial_prod
version:wget https://lmdz.lmd.jussieu.fr/pub/Training/tutorial_prod.tar
User guide
/!\ WARNING 06/2024
The JeanZay calculator, as well as Adastra, do not allow (anymore) communication from/to $STORE for running jobs on the main computing partitions.
As a result, make sure to replace $STORE by $WORK in lmdz_env.sh
wherever relevant.
READ comments at the top of scripts ! Often your questions are answered there.
Note: LMDZ_Setup
has been tested on Adastra and Spirit, and to a lesser extent on JeanZay (legacy support only). No guarantee is made on other platforms, although it should be easy to adapt it. It can also be ran locally - for expert use only.
Structure
Once you have downloaded LMDZ_Setup
, you will find the following main files:
-
main.sh
: the main script. It contains the basic settings you will modify. -
setup.sh
: this script contains the internal workings ofLMDZ_Setup
. It's where you can edit expert-level settings. -
lmdz_env.sh
: this file contains platform-specific configuration, such as where to install the model, where to run the simulations, etc.
How to run a simulation
- Edit
lmdz_env.sh
. Inlmdz_env.sh
, in the functionset_env
, find the case corresponding to your supercomputer:jean-)
for JeanZay,spiri)
for Spirit,adast)
for Adastra. Edit the variables required for your use case. All the variables are documented in the last*)
case. In particular:- you must set
root_dir
to the path where you extractedLMDZ_Setup
.
- you must set
- Edit
main.sh
. Inmain.sh
, edit all relevant settings. - [optional] Edit
setup.sh
. Insetup.sh
, in the functiondefine_expert_options
, edit all relevant settings. - [optional] Edit
DEF/*
. Edit theDEF/*.def
orDEF/XMLfiles*
files, such asconfig.def
, to your liking. The options you specify in main.sh/setup.sh don't require any adjustment here; such adjustments are automatically performed at runtime. - Launch
main.sh
.