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.
main.dox in branches/UKMO/dev_r5518_test_GO6_package_update/NEMOGCM/TOOLS/SIREN/src/docsrc – NEMO

source: branches/UKMO/dev_r5518_test_GO6_package_update/NEMOGCM/TOOLS/SIREN/src/docsrc/main.dox @ 7877

Last change on this file since 7877 was 7877, checked in by frrh, 7 years ago

Merge missing swathe of revisions from branches/2015/nemo_v3_6_STABLE/NEMOGCM
using the command:
svn merge -r6424:6477 ​svn+ssh://forge.ipsl.jussieu.fr/ipsl/forge/projets/nemo/svn/branches/2015/nemo_v3_6_STABLE/NEMOGCM

Note: this required manual conflict resolution of the content of NEMOGCM/TOOLS/SIREN/src/docsrc/
since the existing contenets of those directories in the package branch are not consistent
with the contents of branches/2015/nemo_v3_6_STABLE at revision 6424. (This should be an
incidental matter as the content in question only relates to documentation of NEMO tools
and is not relevant to NEMO source code.)
File size: 1.7 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 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/>
19
20 To know how to install SIREN see @ref md_src_docsrc_1_install.
21
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
29
30<HR>
31   <b>
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
37   - @ref todo
38   </b>
39*/
Note: See TracBrowser for help on using the repository browser.