ICOSA LMDZ directory layout and contents - Revision history

Aurelien.falco: Moved ICOSA_LMDZ page inside tutorial for DYNAMICO-PCM LMDZ physics coupling for better continuity of tutorial

2024-12-10T16:04:07Z

Moved ICOSA_LMDZ page inside tutorial for DYNAMICO-PCM LMDZ physics coupling for better continuity of tutorial

Emillour at 07:30, 15 November 2024

2024-11-15T07:30:19Z

Aurelien.falco: link to dynamico

2024-10-18T12:59:01Z

link to dynamico

Emillour at 13:19, 9 August 2024

2024-08-09T13:19:00Z

Emillour at 13:17, 9 August 2024

2024-08-09T13:17:26Z

Emillour at 22:14, 2 August 2024

2024-08-02T22:14:28Z

Emillour at 20:10, 2 August 2024

2024-08-02T20:10:10Z

Martin.turbet at 08:49, 20 March 2023

2023-03-20T08:49:12Z

Martin.turbet at 10:13, 9 March 2023

2023-03-09T10:13:09Z

Emillour: Created page with "This page describes the directory structure of the ICOSA_LMDZ directory which contains the interface between the DYNAMICO dynamical core and the LMDZ.* physics packages == Th..."

2022-08-05T14:54:12Z

Created page with "This page describes the directory structure of the ICOSA_LMDZ directory which contains the interface between the DYNAMICO dynamical core and the LMDZ.* physics packages == Th..."

New page

This page describes the directory structure of the ICOSA_LMDZ directory which contains the interface between the DYNAMICO dynamical core and the LMDZ.* physics packages

== The ''ICOSA_LMDZ'' directory ==
Once downloaded from the svn server, the ''ICOSA_LMDZ'' directory contents should be:
<pre>
arch build compile_ada make_icosa_lmdz xml
bld.cfg clean compile_occigen src
</pre>
Where the noteworthy elements are:
* The make_icosa_lmdz script, which is the master script to use to compile all components (DYNAMICO, physics package, the interface between the two and the IOIPSL and XIOS libraries).
* Example scripts compile_ada and compile_occigen which are wrappers to the make_icosa_lmdz script with a set of given options. The general idea here is that a user would likewise write his own wrapper script.
* The ''arch'' directory which contains architecture files used by the make_icosa_lmdz script
* The ''src'' directory which contains the source code for the interface
* The ''xml'' directory which contains an example of the iodef.xml file to use, along with related instructions to combining it with other xml file gathered from DYNAMICO and physics packages

== The ''src'' subdirectory ==
This directory contains the source code for the interface, along with subdirectories related to each of the physics packages (currently Generic, Mars and Venus). More general code, i.e. which apply to all the physics packages, such as plugins for the vertical discretization or dissipation factors are located at this level

← Older revision		Revision as of 16:04, 10 December 2024
Line 1:		Line 1:
−	~~This page describes the directory structure of the ICOSA_LMDZ directory which contains the interface between~~ [[~~the DYNAMICO dynamical core]] and the PCM LMDZ.* physics packages~~	+	#redirect[[DYNAMICO_with_LMDZ_physics#The_ICOSA_LMDZ_directory]]
−
−	~~== The ''ICOSA_LMDZ'' directory ==~~
−	~~Once downloaded from the svn server, the ''ICOSA_LMDZ'' directory contents should be:~~
−	~~<pre>~~
−	~~arch bld.cfg build clean compile_adastra-gnu compile_irene-amd make_icosa_lmdz src xml~~
−	~~</pre>~~
−	~~Where the noteworthy elements are:~~
−	* The <font color="green">make_icosa_lmdz</font> script, which is the master script to use to compile all components (DYNAMICO, physics package, the interface between the two and the IOIPSL and XIOS libraries).
−	~~To list available options, run "make_icosa_lmdz -h", which should return something like:~~
−	~~<pre>~~
−	~~Usage :~~
−	~~make_icosa_lmdz [options] -arch arch_name -p phys~~
−	~~[-h] : help~~
−	~~[-prod / -dev / -debug] : compilation mode: production (default) / developpement / debug .~~
−	~~[-full] : recompile all code from scratch~~
−	~~[-nodeps] : do not build dependencies (XIOS and IOIPSL libraries)~~
−	~~-arch arch_name : target architecture~~
−	~~[-arch_path path] : relative PATH to directory containing multi-model~~
−	~~path and environment arch files~~
−	~~-p phys : physics package (e.g. std , venus , mars, ...)~~
−	~~[-p_opt "options"] : additional options for physics package~~
−	~~[-parallel type] : parallelism (none\|mpi\|omp\|mpi_omp)~~
−	~~[-with_xios] : compile and link with XIOS (default)~~
−	~~[-job num] : speed up compilation by using num simulateneous~~
−	~~compilation steps (when possible)~~
−	~~</pre>~~
−	~~Upon successful completion of the compilation step the <font color="blue">bin</font> subdirectory will contain the executable <font color="green">icosa_lmdz.exe</font>~~
−	* Example scripts <font color="green">compile_adastra-gnu</font> and <font color="green">compile_irene-amd</font> which are wrappers to the <font color="green">make_icosa_lmdz</font> script with a set of given options. The general idea here is that a user would likewise write his/her own wrapper script.
−	* The ''arch'' directory which contains architecture files used by the <font color="green">make_icosa_lmdz</font> script
−	* The ''src'' directory which contains the source code for the interface
−	* The ''xml'' directory which contains an example of the <font color="gray">iodef.xml</font> file to use, along with related instructions to combining it with other xml file gathered from DYNAMICO and physics packages
−
−	~~== The ''src'' subdirectory ==~~
−	This directory contains the source code for the interface, along with subdirectories related to each of the physics packages (currently Generic, Mars and Venus). More general code, i.e. which apply to all the physics packages, such as plugins for the vertical discretization or dissipation factors are located at this level. In practice that directory currently contains:
−	~~<pre>~~
−	~~distrib_icosa_lmdz.f90 phymars phyvenus~~
−	~~disvert_icosa_lmdz.f90 phypluto vert_prof_dissip_icosa_lmdz.f90~~
−	~~icosa_lmdz.f90 phystd wrapper.f90~~
−	~~</pre>~~
−	~~where~~
−	* icosa_lmdz.f90 is the main program which is in fact quite minimal as it only needs to set-up pointers for plugin routines and call DYNAMICO's ''icosa_init'' routine
−	* distrib_icosa_lmdz.f90 and wrapper.f90 are quite technical routines handling the parallelism and correspondances between physics and dynamics grids
−	* disvert_icosa_lmdz.f90 is the plugin (inherited from LMDZ.COMMON and follows the vertical coordinate and associated discretization choices made there)
−	* vert_prof_dissip_icosa_lmdz.f90 is the plugin (inherited from LMDZ.COMMON) to set the multiplicative coefficient along the vertical for lateral dissipation
−
−	~~=== The ''src/phy*'' subdirectories ===~~
−	~~These contain the interface to call the main physics driver from the Mars (''phymars''), Pluto (''phypluto''), Generic (''phystd'') or Venus (''phyvenus'') physics packages~~
−
−	~~[[Category:Generic-DYNAMICO]]~~
−	~~[[Category:Mars-DYNAMICO]]~~
−	~~[[Category:Venus-DYNAMICO~~]]

@@ Line 1: / Line 1: @@
-This page describes the directory structure of the ICOSA_LMDZ directory which contains the interface between [[the DYNAMICO dynamical core]] and the LMDZ.* physics packages
+This page describes the directory structure of the ICOSA_LMDZ directory which contains the interface between [[the DYNAMICO dynamical core]] and the PCM LMDZ.* physics packages
 == The ''ICOSA_LMDZ'' directory ==
@@ Line 35: / Line 35: @@
 This directory contains the source code for the interface, along with subdirectories related to each of the physics packages (currently Generic, Mars and Venus). More general code, i.e. which apply to all the physics packages, such as plugins for the vertical discretization or dissipation factors are located at this level. In practice that directory currently contains:
 <pre>
-distrib_icosa_lmdz.f90  phymars   vert_prof_dissip_icosa_lmdz.f90
+distrib_icosa_lmdz.f90  phymars   phyvenus
-disvert_icosa_lmdz.f90  phystd    wrapper.f90
+disvert_icosa_lmdz.f90  phypluto  vert_prof_dissip_icosa_lmdz.f90
-icosa_lmdz.f90          phyvenus
+icosa_lmdz.f90          phystd    wrapper.f90
 </pre>
 where
@@ Line 46: / Line 46: @@
 === The ''src/phy*'' subdirectories ===
-These contain the interface to call the main physics driver from the Mars (''phymars''), Generic (''phystd'') or Venus (''phyvenus'') physics packages
+These contain the interface to call the main physics driver from the Mars (''phymars''), Pluto (''phypluto''), Generic (''phystd'') or Venus (''phyvenus'') physics packages
 [[Category:Generic-DYNAMICO]]
 [[Category:Mars-DYNAMICO]]
 [[Category:Venus-DYNAMICO]]

← Older revision		Revision as of 12:59, 18 October 2024
Line 1:		Line 1:
−	This page describes the directory structure of the ICOSA_LMDZ directory which contains the interface between the DYNAMICO dynamical core and the LMDZ.* physics packages	+	This page describes the directory structure of the ICOSA_LMDZ directory which contains the interface between [[the DYNAMICO dynamical core]] and the LMDZ.* physics packages

	== The ''ICOSA_LMDZ'' directory ==		== The ''ICOSA_LMDZ'' directory ==

@@ Line 27: / Line 27: @@
 </pre>
 Upon successful completion of the compilation step the <font color="blue">bin</font> subdirectory will contain the executable <font color="green">icosa_lmdz.exe</font>
-* Example scripts <font color="green">compile_ada</font> and <font color="green">compile_occigen</font> which are wrappers to the <font color="green">make_icosa_lmdz</font> script with a set of given options. The general idea here is that a user would likewise write his own wrapper script.
+* Example scripts <font color="green">compile_adastra-gnu</font> and <font color="green">compile_irene-amd</font> which are wrappers to the <font color="green">make_icosa_lmdz</font> script with a set of given options. The general idea here is that a user would likewise write his/her own wrapper script.
 * The ''arch'' directory which contains architecture files used by the <font color="green">make_icosa_lmdz</font> script
 * The ''src'' directory which contains the source code for the interface

@@ Line 4: / Line 4: @@
 Once downloaded from the svn server, the ''ICOSA_LMDZ'' directory contents should be:
 <pre>
-arch     build  compile_ada      make_icosa_lmdz  xml
+arch  bld.cfg  build  clean  compile_adastra-gnu  compile_irene-amd  make_icosa_lmdz  src  xml
 </pre>
 Where the noteworthy elements are:
 * The <font color="green">make_icosa_lmdz</font> script, which is the master script to use to compile all components (DYNAMICO, physics package, the interface between the two and the IOIPSL and XIOS libraries).
 * Example scripts <font color="green">compile_ada</font> and <font color="green">compile_occigen</font> which are wrappers to the <font color="green">make_icosa_lmdz</font> script with a set of given options. The general idea here is that a user would likewise write his own wrapper script.
 * The ''arch'' directory which contains architecture files used by the <font color="green">make_icosa_lmdz</font> script

@@ Line 22: / Line 22: @@
 </pre>
 where
-* icosa_lmdz.f90 is the main program
+* icosa_lmdz.f90 is the main program which is in fact quite minimal as it only needs to set-up pointers for  plugin routines and call DYNAMICO's ''icosa_init'' routine
 * distrib_icosa_lmdz.f90 and wrapper.f90 are quite technical routines handling the parallelism and correspondances between physics and dynamics grids
 * disvert_icosa_lmdz.f90 is the plugin (inherited from LMDZ.COMMON and follows the vertical coordinate and associated discretization choices made there)
-* vert_prof_dissip_icosa_lmdz.f90 is the plugin (inherited from LMDZ.COMMON) to set the multiplicative coefficient along the vertical for dissipation
+* vert_prof_dissip_icosa_lmdz.f90 is the plugin (inherited from LMDZ.COMMON) to set the multiplicative coefficient along the vertical for lateral dissipation
 [[Category:Generic-DYNAMICO]]
 [[Category:Mars-DYNAMICO]]
 [[Category:Venus-DYNAMICO]]

@@ Line 17: / Line 17: @@
 This directory contains the source code for the interface, along with subdirectories related to each of the physics packages (currently Generic, Mars and Venus). More general code, i.e. which apply to all the physics packages, such as plugins for the vertical discretization or dissipation factors are located at this level
-[[Category:Generic-Model]]
-[[Category:Mars-Model]]
+[[Category:Generic-DYNAMICO]]

← Older revision		Revision as of 10:13, 9 March 2023
Line 16:		Line 16:
	== The ''src'' subdirectory ==		== The ''src'' subdirectory ==
	This directory contains the source code for the interface, along with subdirectories related to each of the physics packages (currently Generic, Mars and Venus). More general code, i.e. which apply to all the physics packages, such as plugins for the vertical discretization or dissipation factors are located at this level		This directory contains the source code for the interface, along with subdirectories related to each of the physics packages (currently Generic, Mars and Venus). More general code, i.e. which apply to all the physics packages, such as plugins for the vertical discretization or dissipation factors are located at this level
		+
		+	[[Category:Generic-Model]]
		+	[[Category:Mars-Model]]
		+	[[Category:Venus-Model]]
		+	[[Category:Titan-Model]]