source: utils/tools/SIREN/src/docsrc/main.dox @ 12080

Last change on this file since 12080 was 12080, checked in by jpaul, 10 months ago

update nemo trunk

File size: 1.2 KB
Line 
1/*!
2 @mainpage About
3
4 SIREN is a software to set up regional configuration with [NEMO](http://www.nemo-ocean.eu).<br/>
5 Actually SIREN creates the input files you need to run a NEMO regional configuration.<br/>
6 
7 SIREN allows you to create your own regional configuration embedded in a wider one.<br/>
8
9 To know how to install SIREN see @ref md_src_docsrc_1_install.
10
11 You could find a tutorial for a quick start with SIREN in @ref md_src_docsrc_2_quickstart.<br/>
12 For more information about how to use each component of SIREN
13 - see create_coord.f90 to create fine grid coordinate file
14 - see create_bathy.f90 to create fine grid bathymetry
15 - see merge_bathy.f90 to merge fine grid bathymetry
16 - see create_meshmask.f90 to create mesh mask or domain_cfg file.
17 - see create_layout.f90 to create/compute the domain layout of your configuration.
18 - see create_restart.f90 to create initial state file, or other fields.
19 - see create_boundary.F90 to create boundary condition
20
21<HR>
22   <b>
23   - @ref md_src_docsrc_1_install
24   - @ref md_src_docsrc_2_quickstart
25   - @ref md_src_docsrc_3_support_bug
26   - @ref md_src_docsrc_4_codingRules
27   - @ref md_src_docsrc_5_changeLog
28   - @ref todo
29   </b>
30*/
Note: See TracBrowser for help on using the repository browser.