[5037] | 1 | /*! |
---|
| 2 | @mainpage Main Page |
---|
| 3 | @section descr Generic Description |
---|
| 4 | SIREN is a software to create regional configuration with |
---|
| 5 | [NEMO](http://www.nemo-ocean.eu).<br/> |
---|
| 6 | Actually SIREN create input files needed for a basic NEMO configuration.<br/> |
---|
| 7 | |
---|
| 8 | SIREN is composed of a set of 5 Fortran programs : |
---|
| 9 | - create_coord.f90 to create fine grid coordinate file from coarse grid coordinate file. |
---|
| 10 | - create_bathy.f90 to create fine grid bathymetry file over domain. |
---|
| 11 | - merge_bathy.f90 to merge fine grid bathymetry with coarse grid bathymetry at boundaries. |
---|
| 12 | - create_restart.f90 to create initial state file from coarse grid restart or standard outputs. |
---|
| 13 | - create_boundary.f90 to create boundary condition from coarse grid standard outputs. |
---|
| 14 | |
---|
[7877] | 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/> |
---|
[5037] | 19 | |
---|
[7877] | 20 | To know how to install SIREN see @ref md_src_docsrc_1_install. |
---|
[5037] | 21 | |
---|
[7877] | 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 |
---|
[5037] | 29 | |
---|
| 30 | <HR> |
---|
| 31 | <b> |
---|
[7877] | 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 |
---|
[5037] | 37 | - @ref todo |
---|
| 38 | </b> |
---|
| 39 | */ |
---|