Changeset 10552


Ignore:
Timestamp:
2019-01-18T17:33:22+01:00 (15 months ago)
Author:
gsamson
Message:

minor corrections in setup.rst

File:
1 edited

Legend:

Unmodified
Added
Removed
  • NEMO/trunk/doc/rst/source/setup.rst

    r10279 r10552  
    1717 
    1818One can create a new configuration by duplicating one of the reference configurations 
    19 (``ORCA2_LIM3_PISCES`` in the following example) 
    20  
    21 .. code-block:: sh 
    22  
    23    makenemo –n 'ORCA2_LIM3_PISCES_MINE' -r 'ORCA2_LIM3_PISCES' 
     19(``ORCA2_ICE_PISCES`` in the following example) 
     20 
     21.. code-block:: sh 
     22 
     23   makenemo –n 'ORCA2_ICE_PISCES_MINE' -r 'ORCA2_ICE_PISCES' 
    2424 
    2525Option 2: Duplicate with differences 
     
    2727 
    2828Create and compile a new configuration based on a reference configuration 
    29 (``ORCA2_LIM3_PISCES`` in the following example) but with different pre-processor options. 
     29(``ORCA2_ICE_PISCES`` in the following example) but with different pre-processor options. 
    3030For this either add ``add_key`` or ``del_key`` keys as required; e.g. 
    3131 
    3232.. code-block:: sh 
    3333 
    34    makenemo –n 'ORCA2_LIM3_PISCES_MINE' -r 'ORCA2_LIM3_PISCES' del_key 'key_iomput' add_key 'key_xios' 
     34   makenemo –n 'ORCA2_ICE_PISCES_MINE' -r 'ORCA2_ICE_PISCES' del_key 'key_iomput' add_key 'key_diahth' 
    3535 
    3636Option 3: Use the SIREN tools to subset an existing model 
     
    6565This method is used by each of the reference configurations, 
    6666so that downloading their input files linked to their description can help. 
    67 Although starting from scratch it is advisable to create the directory structure to house your new configuration by 
     67Although starting from scratch, it is advisable to create the directory structure to house your new configuration by 
    6868duplicating the closest reference configuration to your target application. 
    6969For example, if your application requires both ocean ice and passive tracers, 
    70 then use the ``ORCA2_LIM3_PISCES`` as template, 
     70then use the ``ORCA2_ICE_PISCES`` as template, 
    7171and execute following command to build your ``MY_NEW_CONFIG`` configuration: 
    7272 
    7373.. code-block:: sh 
    7474 
    75    makenemo –n 'MY_NEW_CONFIG' -r 'ORCA2_LIM3_PISCES' 
     75   makenemo –n 'MY_NEW_CONFIG' -r 'ORCA2_ICE_PISCES' 
    7676 
    7777where ``MY_NEW_CONFIG`` can be substituted with a suitably descriptive name for your new configuration.   
     
    132132As a start, consider the case of starting a completely new ocean-only test case based on 
    133133the ``LOCK_EXCHANGE`` example. 
    134 [Note: we probably need an even more basic example than this with only one namelist and 
     134.. [Note: we probably need an even more basic example than this with only one namelist and 
    135135minimal changes to the usrdef modules] 
    136136 
     
    143143where the ``-t`` option has been used to locate the new configuration in the ``tests`` subdirectory 
    144144(it is recommended practice to keep full configurations and idealised cases clearly distinguishable). 
    145 This command will have created (amongst others) the following files and directories:: 
     145This command will create (amongst others) the following files and directories:: 
    146146 
    147147   ./tests/MY_NEW_TEST: 
     
    211211configuration specific code has now been isolated in the usrdef modules. 
    212212In the case of these last two modules, they are activated only if an ORCA configuration is detected. 
    213 Currently this requires a specific integer variable named ``ORCA`` to be set in a ``domain_cfg.nc`` file. 
    214 [Note: this would be less confusing if the cn_cfg string is read directly as a character attribue from 
     213Currently, this requires a specific integer variable named ``ORCA`` to be set in a ``domain_cfg.nc`` file. 
     214.. [Note: this would be less confusing if the cn_cfg string is read directly as a character attribue from 
    215215the ``domain_cfg.nc`` ] 
    216216 
     
    222222they share common characteristics with your target application. 
    223223 
    224 Whatever the starting point it should not require too many changes or additional lines of code to 
     224Whatever the starting point, it should not require too many changes or additional lines of code to 
    225225produce routines in ``./src/OCE/USR`` that define analytically the domain, 
    226226the initial state and the surface boundary conditions for your new configuration. 
     
    243243From version 4.0, the NEMO release includes a ``tests`` subdirectory containing available and 
    244244up to date test cases build by the community. 
    245 These will not be fully supported as is NEMO reference but should provide a source of raw material. 
     245These will not be fully supported as are NEMO reference configurations, but should provide a source of raw material. 
    246246 
    247247.. _here:                     http://prodn.idris.fr/thredds/catalog/ipsl_public/rron463/catalog.html?dataset=DatasetScanipsl_public/rron463/INPUT_SIREN.tar 
Note: See TracChangeset for help on using the changeset viewer.