source:
branches/UKMO/dev_r5518_amm15_test/NEMOGCM/TOOLS/SIREN/src/docsrc/main.dox
@
7773
Last change on this file since 7773 was 5037, checked in by jpaul, 9 years ago | |
---|---|
File size: 1.5 KB |
Line | |
---|---|
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 | |
15 | To install those programs see @ref md_docsrc_1_install. |
16 | |
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) |
22 | |
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 |
34 | |
35 | <HR> |
36 | <b> |
37 | - @ref md_docsrc_1_install |
38 | - @ref md_docsrc_3_codingRules |
39 | - @ref md_docsrc_4_changeLog |
40 | - @ref todo |
41 | </b> |
42 | */ |
Note: See TracBrowser
for help on using the repository browser.