The makelmdz fcm GCM Compilation Script - Revision history

Emillour at 13:56, 4 February 2026

2026-02-04T13:56:45Z

Martin.turbet at 09:08, 4 February 2026

2026-02-04T09:08:16Z

Emillour at 13:36, 30 May 2025

2025-05-30T13:36:27Z

Emoisan at 14:32, 11 March 2025

2025-03-11T14:32:18Z

Aurelien.falco: /* Overview */

2024-10-22T14:10:43Z

‎Overview

Emillour at 05:30, 25 July 2023

2023-07-25T05:30:50Z

Emillour at 06:48, 17 April 2023

2023-04-17T06:48:27Z

Martin.turbet at 10:24, 9 March 2023

2023-03-09T10:24:19Z

Emillour at 15:26, 13 May 2022

2022-05-13T15:26:17Z

Emillour: Created page with "== Overview == The '''makelmdz_fcm''' script is the (bash) script (located in '''LMDZ.COMMON''' directory) to use to compile the GCM. It is based on FCM and should be run, wit..."

2022-05-13T15:12:32Z

Created page with "== Overview == The '''makelmdz_fcm''' script is the (bash) script (located in '''LMDZ.COMMON''' directory) to use to compile the GCM. It is based on FCM and should be run, wit..."

New page

== Overview ==
The '''makelmdz_fcm''' script is the (bash) script (located in '''LMDZ.COMMON''' directory) to use to compile the GCM. It is based on FCM and should be run, with various options (e.g which physics package to compile the model with, what grid resolution to use, etc.) to generate the sought executable.

== makelmdz_fcm options ==
To list available options, run "makelmdz_fcm -h", which should return something like:
<pre>
Usage :
makelmdz_fcm [options] -arch arch_name exec
[-h] : brief help
[-d [[IMx]JMx]LM] : IM, JM, LM are the dimensions in x, y, z (default: 96x72x19)
[-s nscat] : (Generic) Number of radiatively active scatterers
[-b IRxVIS] : (Generic) Number of infrared (IR) and visible (VIS) bands for radiative transfer
[-p PHYS] : set of physical parametrizations (in libf/phyPHYS), (default: lmd)
[-prod / -dev / -debug] : compilation mode production (default) / developement / debug .
[-c false/MPI1/OMCT] : (Earth) coupling with ocean model : MPI1/OMCT/false (default: false)
[-v false/orchidee2.0/orchidee1.9/true] : (Earth) version of the vegetation model to include (default: false)
false : no vegetation model
orchidee2.0 : compile using ORCHIDEE 2.0 (or more recent version)
orchidee1.9 : compile using ORCHIDEE up to the version including OpenMP in ORCHIDEE : tag 1.9-1.9.5(version AR5)-1.9.6
true : (obsolete; for backward compatibility) use ORCHIDEE tag 1.9-1.9.6
[-chimie INCA/false] : (Earth) with INCA chemistry model or without (default: false)
[-cosp true/false] : (Earth) add the cosp model (default: false)
[-sisvat true/false] : (Earth) compile with/without sisvat package (default: false)
[-rrtm true/false] : (Earth) compile with/without rrtm package (default: false)
[-dust true/false] : (Earth) compile with/without the dust package by Boucher and co (default: false)
[-strataer true/false] : (Earth) compile with/without the strat aer package by Boucher and co (default: false)
[-parallel none/mpi/omp/mpi_omp] : parallelism (default: none) : mpi, openmp or mixted mpi_openmp
[-g GRI] : grid configuration in dyn3d/GRI_xy.h (default: reg, inclues a zoom)
[-io ioipsl/mix/xios] : Input/Output library (default: ioipsl)
[-include INCLUDES] : extra include path to add
[-cpp CPP_KEY] : additional preprocessing definitions
[-adjnt] : adjoint model, not operational ...
[-mem] : reduced memory dynamics (if in parallel mode)
[-filtre NOMFILTRE] : use filtre from libf/NOMFILTRE (default: filtrez)
[-link LINKS] : additional links with other libraries
[-j n] : active parallel compiling on ntask
[-full] : full (re-)compilation (from scratch)
[-libphy] : only compile physics package (no dynamics or main program)
[-fcm_path path] : path to the fcm tool (default: tools/fcm/bin)
[-ext_src path] : path to an additional set of routines to compile with the model
[-arch_path path] : path to architecture files (default: arch)
-arch arch : target architecture
exec : executable to build
</pre>
Note that some options are meaningless for the Generic GCM. This is due to the fact that we try to coordinates tools like '''makelmdz_fcm''' between different physics packages. In what follows, we only discuss those relevant for the Generic physics.

The only mandatory argument are '''-arch''' and '''exec''', but in practice you'll need to specify many more (as defaults rarely suit all needs)

== Details of main makelmdz_fcm options ==
<pre>-d IMxJMxLM</pre>
As the default is to run on a fixed longitude-latitude grid (set when compiling), option "-d" is necessary to specify the number of grid points iimxjjmxlllm (actually iim is the number of intervals along longitude, jjm is the number of intervals along latitude and llm the number of atmospheric layers).

If compiling one of the 1D models, then only the number of layers (llm) needs be specified, e.g. <code>-d 78</code>.

<pre>-p std</pre>
The <code>-p</code> option enables picking which physics package to compile with. The adequate argument for the Generic model is <code>std</code>, i.e. corresponding code will be found in '''LMDZ.COMMON/libf/phystd'''

<pre>-b IRxVIS</pre>
Number of bands in the InfraRed and Visible for the radiative transfer. Note that this requires that the corresponding appropriate input files are available (at run time).

<pre>-s nscat</pre>
Number of radiatively active scatterers

<pre>-prod / -dev / -debug</pre>
Compilation mode. Default is <code>-prod</code>, i.e. "production" mode, where compiler optimization are on (as defined in the arch files; see [[The_Target_Architecture_("arch")_Files]] for details). When checking/debugging you definitely want to set <code>-debug</code>

<pre>-j n</pre>
With this option one can speed up compilation by letting <code>make</code> compile simultaneously (and if possible) up to <code>n</code> routines in parallel (note that this "parallel compilation" has nothing to do with the code being compiled for serial or parallel use as specified via option <code>-parallel ...</code>). In practice using <code>-j 8</code> or <code>-j 4</code> works well.

<pre>-parallel none/mpi/omp/mpi_omp</pre>
This option is to specify whether the model should be compiled in serial mode (default) or in parallel using MPI (<code>mpi</code>) only, or using OpenMP (<code>omp</code>) only, or both MPI and OpenMP (<code>mpi_omp</code>).

In practice, one most often needs to run in parallel and using both MPI and OpenMP, so <code>-parallel mpi_omp</code> is advised.

<pre>-io ioipsl/mix/xios</pre>
This option specifies which IO (Input/Output) library is going to be used by the model. Default is <code>-io ioipsl</code>, which is becoming depreciated for the GCM but mandatory for the 1D model. Note that when compiling with XIOS: <code>-io xios</code> on still needs to also use the IOIPSL library (which handles the reading of the run.def and companion files).

<pre>-full</pre>
Impose a full cleanup (i.e. removing past object and library files) to ensure recompiling the model from scratch.

@@ Line 79: / Line 79: @@
 === Generic model specific options ===
-To compile with the Generic physics package, the adequate argument to <code>-p</code> is <code>std</code>, i.e. corresponding code will be found in '''LMDZ.COMMON/libf/phygeneric''' and '''LMDZ.COMMON/libf/aeronostd''', which are simply links to '''LMDZ.GENERIC/libf/phygeneric''' and '''LMDZ.GENERIC/libf/aeronostd''':
+To compile with the Generic physics package, the adequate argument to <code>-p</code> is <code>generic</code>, i.e. corresponding code will be found in '''LMDZ.COMMON/libf/phygeneric''' and '''LMDZ.COMMON/libf/aeronogeneric''', which are simply links to '''LMDZ.GENERIC/libf/phygeneric''' and '''LMDZ.GENERIC/libf/aeronogeneric''':
-<pre>-p std</pre>
+<pre>-p generic</pre>
 Additional options one must provide when compiling with the Generic physics include:

@@ Line 79: / Line 79: @@
 === Generic model specific options ===
-To compile with the Generic physics package, the adequate argument to <code>-p</code> is <code>std</code>, i.e. corresponding code will be found in '''LMDZ.COMMON/libf/phystd''' and '''LMDZ.COMMON/libf/aeronostd''', which are simply links to '''LMDZ.GENERIC/libf/phystd''' and '''LMDZ.GENERIC/libf/aeronostd''':
+To compile with the Generic physics package, the adequate argument to <code>-p</code> is <code>std</code>, i.e. corresponding code will be found in '''LMDZ.COMMON/libf/phygeneric''' and '''LMDZ.COMMON/libf/aeronostd''', which are simply links to '''LMDZ.GENERIC/libf/phygeneric''' and '''LMDZ.GENERIC/libf/aeronostd''':
 <pre>-p std</pre>

← Older revision		Revision as of 13:36, 30 May 2025
Line 98:		Line 98:
	<pre>-p titan</pre>		<pre>-p titan</pre>

		+	== Troubleshooting ==
		+	If when you run <code>makelmdz_fcm</code> you get the following error message:
		+	<pre>
		+	dirname: missing operand
		+	</pre>
		+	This is because you do not have the <code>fcm</code> command available, either because you have not installed "fcm" (see the relevant "Overview" page for the PCM you are using) or because you have not added the <code>FCM_V1.2/bin</code> directory to your <code>PATH</code> environment variable.

	[[Category:Generic-Model]]		[[Category:Generic-Model]]

@@ Line 91: / Line 91: @@
 === Venus model specific options ===
-To compile with the Venus physics package, the adequate argument to <code>-p</code> is <code>mars</code>, i.e. corresponding code will be found in '''LMDZ.COMMON/libf/phyvenus''', which is simply a link to '''LMDZ.VENUS/libf/phyvenus''':
+To compile with the Venus physics package, the adequate argument to <code>-p</code> is <code>venus</code>, i.e. corresponding code will be found in '''LMDZ.COMMON/libf/phyvenus''', which is simply a link to '''LMDZ.VENUS/libf/phyvenus''':
 <pre>-p venus</pre>

← Older revision		Revision as of 10:24, 9 March 2023
Line 81:		Line 81:
	<pre>-full</pre>		<pre>-full</pre>
	Impose a full cleanup (i.e. removing past object and library files) to ensure recompiling the model from scratch.		Impose a full cleanup (i.e. removing past object and library files) to ensure recompiling the model from scratch.
		+
		+	[[Category:Generic-Model]]
		+	[[Category:Mars-Model]]
		+	[[Category:Venus-Model]]
		+	[[Category:Titan-Model]]

@@ Line 1: / Line 1: @@
 == Overview ==
-The '''makelmdz_fcm''' script is the (bash) script (located in '''LMDZ.COMMON''' directory) to use to compile the GCM. It is based on FCM and should be run, with various options (e.g which physics package to compile the model with, what grid resolution to use, etc.) to generate the sought executable.
+The '''makelmdz_fcm''' script is the (bash) script (located in '''LMDZ.COMMON''' directory) to use to [[Quick_Install_and_Run#Compiling_the_GCM|compile the GCM]]. It is based on FCM and should be run, with various options (e.g which physics package to compile the model with, what grid resolution to use, etc.) to generate the sought executable.
 == makelmdz_fcm options ==

@@ Line 85: / Line 85: @@
 <pre>-b IRxVIS</pre>
 Number of bands in the InfraRed and Visible for the radiative transfer. Note that this requires that the corresponding appropriate input files are available (at run time).
 === Mars model specific options ===

@@ Line 43: / Line 43: @@
   exec                      : executable to build
 </pre>
-Note that some options are meaningless for the Generic GCM. This is due to the fact that we try to coordinates tools like '''makelmdz_fcm''' between different physics packages. In what follows, we only discuss those relevant for the Generic physics.
+Note that some options are meaningless for the Generic GCM. This is due to the fact that we try to coordinates tools like '''makelmdz_fcm''' between different physics packages.
 The only mandatory argument are '''-arch''' and '''exec''', but in practice you'll need to specify many more (as defaults rarely suit all needs)
@@ Line 52: / Line 52: @@
 If compiling one of the 1D models, then only the number of layers (llm) needs be specified, e.g. <code>-d 78</code>.
 <pre>-prod / -dev / -debug</pre>
@@ Line 81: / Line 72: @@
 <pre>-full</pre>
 Impose a full cleanup (i.e. removing past object and library files) to ensure recompiling the model from scratch.
 [[Category:Generic-Model]]

@@ Line 73: / Line 73: @@
 In practice, one most often needs to run in parallel and using both MPI and OpenMP, so <code>-parallel mpi_omp</code> is advised.
-<pre>-io ioipsl/mix/xios</pre>
+<pre>-io ioipsl/noioipsl/mix/xios</pre>
-This option specifies which IO (Input/Output) library is going to be used by the model. Default is <code>-io ioipsl</code>, which is becoming depreciated for the GCM but mandatory for the 1D model. Note that when compiling with XIOS: <code>-io xios</code> on still needs to also use the IOIPSL library (which handles the reading of the run.def and companion files).
+This option specifies which IO (Input/Output) library is going to be used by the model. Default is <code>-io ioipsl</code>, which is becoming depreciated for the GCM but mandatory for the 1D model. Note that when compiling with XIOS: <code>-io xios</code> on still needs to also use the IOIPSL library (which handles the reading of the run.def and companion files). It is also possible to compile without the IOISPL or XIOS libraries by specifying <code>-io noioipsl</code> (using an internal version of the getin() function from reading the *.def files; not recommended, but might help if building IOIPSL is a problem).
 <pre>-full</pre>
 Impose a full cleanup (i.e. removing past object and library files) to ensure recompiling the model from scratch.