.. _forcing.obc.config:

OBC configuration
=================

* To generate OBC from 01/01/2014 to 05/01/2014, run treatment **obc**:

::

    launch_mangae config_mangae.cfg -s 2014-01-01,00:00 -e 2014-01-05,00:00 --only obc

Output files:
  * **./inputs/MANGAE2500-r1630/obc/mangae_obc_north.nc**
  * **./inputs/MANGAE2500-r1630/obc/mangae_obc_south.nc**
  * **./inputs/MANGAE2500-r1630/obc/mangae_obc_west.nc**

* Configuration is precised in configuration file **config_mangae.cfg**, **Section obc**

::

  #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
  # Section obc
  # Préparation des conditions aux frontières ouvertes
  # Entrées disponibles :
  #     depend       : liste contenant les noms des traitements dont dépend le traitement courant, liste vide si aucune dépendance
  #     description  : description du traitement (récupéré via l'option --list du script launcher.py)
  #     name         : nom du job soumis sur le calculateur (!!!! ne pas dépasser 15 caractères !!!)
  #     launch       : procédure de lancement associée 
  #     startshift   : optionnel, réél indiquant le décalage en jours du début du traitement par rapport �|  la date de démarrage de référence 
  #     lon_to_ni    : optionnel, logique permettant d'activer le renommage des dimensions (considéré comme False si absent)
  # Sous-sections :
  #     options      : sous-section contenant les arguments optionnels de la fonction de récupération des fichiers OBC (retrieve) 
  #     extract      : sous-section concernant l'exécution du programme Extract, contient les entrées suivantes
  #       ogcm_model   : modèle de données OGCM
  #       extract_dir  : emplacement du répertoire Extract
  #       exe          : chemin complet vers l'exécutable Extract
  #       namelist_ref : chemin complet vers la namelist de référence d'Extract qui sera modifiée par la chaîne
  #       namelist     : sous-section d'édition de la namelist de reference     
  #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++  

  [[obc]]
    depend = []
    description = 'Preparation of open boundaries conditions'
    name = 'mang25_obc'
    launch = 'tools.obc.launch_obc'
    lon_to_ni = False
    [[[options]]]
      lonmin = -20
      lonmax = 11
      latmin = 39
      latmax = 57
      verbose = True
    [[[extract]]]
      ogcm_model = 'mercator_psy2v4'
      extract_dir =  '/work/lpineaug/FORMATION_CHAINOP/CHAINOP/tools_fortran/Extract/'
      exe = '%(extract_dir)s/extract_exe'
      namelist_ref = '%(extract_dir)s/IN/namelist_ref'
      [[[[namelist]]]]
        l_extract_obc = '.true.'
        file_coarse = 'MERCATOR_PSY2V4.nc'
        l_obc_south = '.true.'
        file_fine_s = 'mangae_obc_south.nc'
        l_obc_west = '.true.'
        file_fine_w = 'mangae_obc_west.nc'
        l_obc_north = '.true.'
        file_fine_n = 'mangae_obc_north.nc'


* *extract* is run in repertory **./tools_fortran/Extract** (see *extract_dir* in config file)
* At the beginning of the run, **./tools_fortran/Extract/IN/namelist_ref** is copied in **./tools_fortran/Extract/IN/namelist**
* To change parameters, make it directly inf configuration file in **[[[[namelist]]]]**

* You can select the boundaries of the area you want for input file (here PSY2V4) for  *extract* (think of the file size !)

* For **ogcm_model**, you can choose between:
   * **'mercator_psy2v4'**
   * **'mercator_psy2v4_rejeu'** 
   * **'mercator_glorys2v2'**
   * **'mfs_sys4'**
   * **'mfs_sys4v2'**
   * **'mfs_sys4v3'**
   * **'mfs_sys4v4'**

+-----------------------+------------+---------------+------------+------------+
| Model name            | Resolution | Extension (°) | Start date | End date   |
+=======================+============+===============+============+============+
| mercator_psy2v4       | 0.0833°    | -20 17 26 64  | 2013-04-03 | now        |
+-----------------------+------------+---------------+------------+------------+
| mercator_psy2v4_rejeu | 0.0833°    | -20 17 26 64  | 2010-01-01 | 2013-05-07 |
+-----------------------+------------+---------------+------------+------------+
| mercator_glorys2v2    | 0.25°      | -22 43 31 75  | 1992-06-03 | 2009-12-30 |
+-----------------------+------------+---------------+------------+------------+
| mfs_sys4              | 0.0625°    | -6 37 30 46   | 2004-01-02 | 2012-03-11 |
+-----------------------+------------+---------------+------------+------------+
| mfs_sys4v2            | 0.0625°    | -6 37 30 46   | 2011-01-04 | 2014-06-25 |
+-----------------------+------------+---------------+------------+------------+
| mfs_sys4v3            | 0.0625°    | -6 37 30 46   | 2014-06-20 | 2015-05-08 |
+-----------------------+------------+---------------+------------+------------+
| mfs_sys4v4            | 0.0625°    | -6 37 30 46   | 2015-04-28 | now        |
+-----------------------+------------+---------------+------------+------------+