Changeset 4758


Ignore:
Timestamp:
10/18/19 14:32:26 (2 years ago)
Author:
omamce
Message:

O.M. : update README file of MOSAIX

File:
1 edited

Legend:

Unmodified
Added
Removed
  • TOOLS/MOSAIX/README.md

    r4757 r4758  
    2525MOSAIX 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. 
    2626 
    27 MOSAIX can generate 2nd order conservative interpolation weights. They are used in place of bilinear interpolation by [OASIS-MCT](https://portal.enes.org/oasis) 
     27MOSAIX can generate 2<sup>nd</sup> order conservative interpolation weights. They are used in place of bilinear interpolation by [OASIS-MCT](https://portal.enes.org/oasis) 
    2828 
    2929As MOSAIX uses XIOS, it works in parallel, using MPI distributed memory. 
     
    3131## Compatibility with MOSAIC 
    3232 
    33 -   Weights are generally compatible with the weights generated by MOSAIC. The precision of the interpolation (conservation) is improved. 
     33-   Weights are not compatible with the weights generated by MOSAIC. The precision of the interpolation (conservation) is improved. The ocean mask interpolated on the atmosphere grid will be slightly different, and not compatible. 
    3434 
    3535-   **Run-off** : runoff weights are computed with a different algorithm, the result can be quite different. 
     
    4040 
    4141-   Creates a non-masked grid for atmosphere, to compute integrals of run-off 
    42 -   Creates 2^nd^ order interpolation weights that conserve posivity. They won't be conservative. 
     42-   Creates 2<sup>nd</sup> order interpolation weights that conserve posivity. They won't be conservative. 
    4343 
    4444## Known problems 
     
    7878All netCDF files have a detailed header. 
    7979 
    80 -   Weight files rmp_*. Should have a rather explicit name. The name is configurable at the beginning of `CreateWeightsMask.bash`. 
    81 -   Diagnostic file used for debug dia_*.nc for each rmp file, except for runoff and calving. Debug information are directly in weight files in this last cases. 
    82 -   Grid description file for OASIS-MCT grids.nc, areas.nc and masks.nc. 
    83 -   A file containing the fraction of ocean in each atmosphere grid box. For instance ICO40\_grid\_maskFrom_eORCA1.2.nc. 
    84 -   A README file. Includes a checksum for each generated files. 
     80-   Weight files `rmp_*`. Should have a rather explicit name. The name is configurable at the beginning of `CreateWeightsMask.bash`. 
     81-   Diagnostic file used for debug `dia_*.nc` for each rmp file, except for runoff and calving. Debug information are directly in weight files in this last cases. 
     82-   Grid description file for OASIS-MCT `grids.nc`, `areas.nc` and `masks.nc`. 
     83-   A file containing the fraction of ocean in each atmosphere grid box. For instance `ICO40_grid_maskFrom_eORCA1.2.nc`. 
     84-   A `README` file. Includes a checksum for each generated files. 
    8585 
    8686## Scripts and codes 
     
    9090-   **CreateOasisGrids.bash**. Creates files `grids.nc`, `areas.nc` and `masks.nc` with information from both models, suitable for OASIS-MCT. Mono CPU. Launched by `CreateWeights.bash`. 
    9191 
    92 -   **update_xml.py**. Python script used to perform on the fly editing of xml files. Used by CreateWeights.bash. More information with `python update_xml.py -h`. 
     92-   **update_xml.py**. Python script used to perform on the fly editing of xml files. Used by `CreateWeights.bash`. More information with `python update_xml.py -h`. 
    9393 
    9494-   **iodef\_atm\_to_oce.xml** and **iodef\_oce\_to_atm.xml**. xml files read by `interpol.f90`. These files are edited by update_xml.py. 
     
    9797 
    9898-   **make_mosaix**. Small script for compiling **interpol.f90**. You need to compile XIOS first. Uses compiler, compiler options and librairies defined by XIOS. 
    99      
     99```bash  
    100100        make_xios \[options\] 
    101101            options : 
     
    103103                   \[--full\]      : to regenerate dependencies and recompile from scratch 
    104104            Example : ./make_mosaix --xios ../XIOS 
    105      
    106  
    107 - **RunoffWeights.py**. Python code to generates weights for run-off. Launched by CreateWeights.bash. More information with python `RunOffWeights.py -h`. 
     105``` 
     106                         
     107- **RunoffWeights.py**. Python code to generates weights for run-off. Launched by `CreateWeights.bash`. More information with python `RunOffWeights.py -h`. 
    108108 
    109109  - Defines a coastal band on land in the atmosphere model. For LMDZ rectilinear grids, the width of this band is parametrized, in grid points. For ico grids, the band contains only point with a fraction of ocean in \]0,1\[. 
Note: See TracChangeset for help on using the changeset viewer.