=== MOSAIX ===

MOSAIX is a small set of fortran routines, bash scripts, python scripts and xml files allowing to generate coupling weights for IPSL Earth System Model. It is under development, and presently not used by the production runs. It aims to replace the old MOSAIC software. It uses XIOS as a library to compute weights. In the present state, it can handle ORCA, LMDZ lon/lat and DYNAMICO grids.

MOSAIX work in parallel, using MPI distributed memory.

== Known problems ==
* Generation of weights for 2^nd^ order interpolation doesn't work
* Some precision problems.

== Code availability ==
 * Web : https://forge.ipsl.jussieu.fr/igcmg/browser/TOOLS/MOSAIX
 * SVN : {{{svn co http://forge.ipsl.jussieu.fr/igcmg/svn/TOOLS/MOSAIX MOSAIX}}}
* SVN : {{{svn co svn+ssh://<login>@forge.ipsl.jussieu.fr/ipsl/forge/projets/igcmg/svn/TOOLS/MOSAIX MOSAIX}}}

== Portability ==
MOSAIX has been tested on Curie (TGCC). 

== Requirement ==
* A working XIOS library (http://forge.ipsl.jussieu.fr/ioserver).
* fcm version 1.2
* NetCDF. See XIOS for a suitable version.
* Python version>2.7
* NCO

== Input files ==
MOSAIX needs files describing the grid of the models. See {{{CreateWeightsMask.bash}}}

== Scripts and codes ==

* '''!CreateWeightsMask.bash'''. Creates the weights to interpolate between atmospheric and ocean grid. Weight files are suitable for OASIS-MCT. Creates the fraction of ocean in atmospheric grid cells. Use parallel processing with MPI.

* '''!CreateOasisGrids.bash'''.  Creates files grids.nc, areas.nc and masks.nc with information from both models, suitable for OASIS-MCT. Mono CPU.

* '''update_xml.py'''. Python script used to perform on the fly editing of xml files. Used by the previous bashes.

* '''iodef_atm_to_oce.xml''' and '''iodef_oce_to_atm.xml'''. 

* '''MOSAIX/src/MOSAIX/interpol.f90'''. Fortran source using the XIOS library. 

* '''bld.cfg'''. fcm configuration file to compile {{{interpol.f90}}}. 

* '''CreateRestartOce4Oasis.bash'''. Creates restart files for the coupler, ocean side. Should be moved elsewhere. Mono CPU.

* '''CreateRestartAtm4Oasis.bash'''.  Creates restart files for the coupler, atmosphere side. Should be moved elsewhere. Mono CPU.

== Grids ==
* [tuv]orc. ORCA grid at [tuv] points. Masked on land, with area equal to grid box surface
* tlmd. LMD rectilinear grid at scalar (physics) point. Masked on land, with area equal to grid box surface.
* tico. LMD icosahedron grid at scalar (physics) point. Masked on land, with area equal to grid box surface.
* olmd. LMD rectilinear grid at scalar (physics) point. Not masked,  with area equal to 1..
* oico. LMD icosahedron grid at scalar (physics) point. Not masked,  with area equal to 1.
* corc. ORCA grid at t point. Masked on land, duplicated (from periodicity) point masked, with area equal to grid box surface.