- Timestamp:
- 2016-11-28T17:04:10+01:00 (7 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
branches/2016/dev_INGV_UKMO_2016/NEMOGCM/TOOLS/SIREN/src/docsrc/main.dox
r5037 r7351 1 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/> 2 @mainpage About 3 4 SIREN is a software to create regional configuration with [NEMO](http://www.nemo-ocean.eu).<br/> 6 5 Actually SIREN create input files needed for a basic NEMO configuration.<br/> 6 7 SIREN allows you to create your own regional configuration embedded in a wider one.<br/> 8 In order to help you, a set of GLORYS files (global reanalysis on ORCA025 grid), as well as examples 9 of namelists are available in dods repository. 10 11 @note This software was created, and is maintain by the Configuration Manager Working Group, composed 12 of NEMO system team members. 7 13 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 To know how to install SIREN see @ref md_docsrc_1_install. 14 15 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 16 You could find a tutorial for a quick start with SIREN in @ref md_docsrc_2_quickstart.<br/> 17 For more information about how to use each component of SIREN 18 - see create_coord.f90 to create fine grid coordinate file 19 - see create_bathy.f90 to create fine grid bathymetry 20 - see merge_bathy.f90 to merge fine grid bathymetry 21 - see create_restart.f90 to create initial state file, or other fields. 22 - see create_boundary.F90 to create boundary condition 34 23 35 24 <HR> 36 25 <b> 37 26 - @ref md_docsrc_1_install 38 - @ref md_docsrc_3_codingRules 39 - @ref md_docsrc_4_changeLog 27 - @ref md_docsrc_2_quickstart 28 - @ref md_docsrc_3_support_bug 29 - @ref md_docsrc_4_codingRules 30 - @ref md_docsrc_5_changeLog 40 31 - @ref todo 41 32 </b>
Note: See TracChangeset
for help on using the changeset viewer.