New URL for NEMO forge!   http://forge.nemo-ocean.eu

Since March 2022 along with NEMO 4.2 release, the code development moved to a self-hosted GitLab.
This present forge is now archived and remained online for history.
Changeset 9817 for branches/UKMO/dev_r5518_nemo2cice_prints/NEMOGCM/TOOLS/SIREN/src/docsrc/main.dox – NEMO

Ignore:
Timestamp:
2018-06-21T11:58:42+02:00 (6 years ago)
Author:
dancopsey
Message:

Merged in GO6 package branch up to revision 8356.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • branches/UKMO/dev_r5518_nemo2cice_prints/NEMOGCM/TOOLS/SIREN/src/docsrc/main.dox

    r5037 r9817  
    1313   - create_boundary.f90 to create boundary condition from coarse grid standard outputs. 
    1414 
    15 To install those programs see @ref md_docsrc_1_install. 
     15 SIREN is a software to set up regional configuration with [NEMO](http://www.nemo-ocean.eu).<br/>  
     16 Actually SIREN creates the input files you need to run a NEMO regional configuration.<br/> 
     17  
     18 SIREN allows you to create your own regional configuration embedded in a wider one.<br/> 
    1619 
    17  @note SIREN can not: 
    18  - create global configuration 
    19  - create configuarion around or close to north pole 
    20  - change number of vertical level 
    21  - change grid (horizontal or vertical) 
     20 To know how to install SIREN see @ref md_src_docsrc_1_install. 
    2221 
    23  @section howto How to use 
    24    @subsection howto_coord to create fine grid coordinate file 
    25    see create_coord.f90 
    26    @subsection howto_bathy to create fine grid bathymetry 
    27    see create_bathy.f90 
    28    @subsection howto_merge to merge fine grid bathymetry 
    29    see merge_bathy.f90 
    30    @subsection howto_restart to create initial state file 
    31    see create_restart.f90 
    32    @subsection howto_boundary to create boundary condition 
    33    see create_boundary.f90 
     22 You could find a tutorial for a quick start with SIREN in @ref md_src_docsrc_2_quickstart.<br/> 
     23 For more information about how to use each component of SIREN 
     24 - see create_coord.f90 to create fine grid coordinate file 
     25 - see create_bathy.f90 to create fine grid bathymetry 
     26 - see merge_bathy.f90 to merge fine grid bathymetry 
     27 - see create_restart.f90 to create initial state file, or other fields. 
     28 - see create_boundary.F90 to create boundary condition 
    3429 
    3530<HR> 
    3631   <b> 
    37    - @ref md_docsrc_1_install 
    38    - @ref md_docsrc_3_codingRules 
    39    - @ref md_docsrc_4_changeLog 
     32   - @ref md_src_docsrc_1_install 
     33   - @ref md_src_docsrc_2_quickstart 
     34   - @ref md_src_docsrc_3_support_bug 
     35   - @ref md_src_docsrc_4_codingRules 
     36   - @ref md_src_docsrc_5_changeLog 
    4037   - @ref todo 
    4138   </b> 
Note: See TracChangeset for help on using the changeset viewer.