Changeset 6625 for branches/UKMO/dev_r5518_v3.4_asm_nemovar_community/NEMOGCM/TOOLS/SIREN/src/docsrc

Timestamp:

2016-05-26T11:08:07+02:00 (8 years ago)

Author:

kingr

Message:

Rolled back to r6613

Location:

branches/UKMO/dev_r5518_v3.4_asm_nemovar_community/NEMOGCM/TOOLS/SIREN/src/docsrc

Files:

• 1_install.md (modified) (1 diff)
• 2_quickstart.md (deleted)
• 3_codingRules.md (copied) (copied from branches/UKMO/dev_r5518_v3.4_asm_nemovar_community/NEMOGCM/TOOLS/SIREN/src/docsrc/3_codingRules.md)
• 3_support_bug.md (deleted)
• 4_changeLog.md (copied) (copied from branches/UKMO/dev_r5518_v3.4_asm_nemovar_community/NEMOGCM/TOOLS/SIREN/src/docsrc/4_changeLog.md)
• 4_codingRules.md (deleted)
• 5_changeLog.md (deleted)
• 6_perio.md (deleted)
• Image/boundary_NEATL36_70.png (deleted)
• Image/grid_glob_band_20.png (deleted)
• Image/grid_glob_band_30.png (deleted)
• Image/grid_glob_over_20.png (deleted)
• Image/grid_glob_over_30.png (deleted)
• Image/grid_zoom_40.png (modified) (previous)
• Image/grid_zoom_60.png (deleted)
• Image/perio0_20.png (deleted)
• Image/perio1_20.png (deleted)
• Image/perio2_20.png (deleted)
• Image/perio3_20.png (deleted)
• Image/perio4_20.png (deleted)
• Image/perio5_20.png (deleted)
• Image/perio6_20.png (deleted)
• main.dox (modified) (1 diff)

branches/UKMO/dev_r5518_v3.4_asm_nemovar_community/NEMOGCM/TOOLS/SIREN/src/docsrc/1_install.md

@@ -1 @@
-# Download
+# How to Install
 
-# Download NEMO #
-to install SIREN, you should first download NEMO.
-see [NEMO quick start guide](http://www.nemo-ocean.eu/Using-NEMO/User-Guides/Basics/NEMO-Quick-Start-Guide)
+# Install NEMO
+to install SIREN, you should first install NEMO.
+see [here](http://www.nemo-ocean.eu/Using-NEMO/User-Guides/Basics/NEMO-Quick-Start-Guide)
 
-# Compile SIREN #
+# Compile SIREN
 when NEMO is installed, you just have to compile SIREN codes:
-   1. go to ./NEMOGCM/TOOLS
-   2. run maketools (ex: ./maketools -n SIREN -m ifort_mpi_beaufix)
+1. go to ./NEMOGCM/TOOLS
+2. use maketools <br/>
+   to get help: maketools -h 
 
-      @note to get help on maketools: ./maketools -h
+# Fortran Compiler
+   SIREN codes were succesfully tested with :
+   - ifort (version 12.0.4)
+   - gfortran (version 4.7.2 20121109)
+<!--   - pgf95 (version 13.9-0) -->
 
-# Fortran Compiler #
-SIREN codes were succesfully tested with :
-  - ifort (version 15.0.1)
-  - gfortran (version 4.8.2 20140120) 
-
-<HR>
-  <b>
-  - @ref index
-  - @ref md_docsrc_2_quickstart
-  - @ref md_docsrc_3_support_bug
-  - @ref md_docsrc_4_codingRules
-  - @ref md_docsrc_5_changeLog
-  - @ref todo
-  </b>
+ <HR>
+   <b>
+   - @ref index
+   - @ref md_docsrc_3_codingRules
+   - @ref md_docsrc_4_changeLog
+   - @ref todo
+   </b>

branches/UKMO/dev_r5518_v3.4_asm_nemovar_community/NEMOGCM/TOOLS/SIREN/src/docsrc/main.dox

@@ -1 +1 @@
 /*!
- @mainpage About 
+ @mainpage Main Page
+ @section descr Generic Description
+ SIREN is a software to create regional configuration with
+ [NEMO](http://www.nemo-ocean.eu).<br/> 
+ Actually SIREN create input files needed for a basic NEMO configuration.<br/>
+ 
+ SIREN is composed of a set of 5 Fortran programs :
+   - create_coord.f90 to create fine grid coordinate file from coarse grid coordinate file.
+   - create_bathy.f90 to create fine grid bathymetry file over domain.
+   - merge_bathy.f90 to merge fine grid bathymetry with coarse grid bathymetry at boundaries.
+   - create_restart.f90 to create initial state file from coarse grid restart or standard outputs.
+   - create_boundary.f90 to create boundary condition from coarse grid standard outputs.
 
- SIREN is a software to create regional configuration with [NEMO](http://www.nemo-ocean.eu).<br/> 
- Actually SIREN create input files needed for a basic NEMO configuration.<br/>
+To install those programs see @ref md_docsrc_1_install.
 
- SIREN allows you to create your own regional configuration embedded in a wider one.<br/>
- In order to help you, a set of GLORYS files (global reanalysis on ORCA025 grid), as well as examples
- of namelists are available in dods repository.
+ @note SIREN can not:
+ - create global configuration
+ - create configuarion around or close to north pole
+ - change number of vertical level
+ - change grid (horizontal or vertical)
 
- @note This software was created, and is maintain by the Configuration Manager Working Group, composed
- of NEMO system team members.
- 
- To know how to install SIREN see @ref md_docsrc_1_install.
-
- You could find a tutorial for a quick start with SIREN in @ref md_docsrc_2_quickstart.<br/>
- For more information about how to use each component of SIREN
- - see create_coord.f90 to create fine grid coordinate file
- - see create_bathy.f90 to create fine grid bathymetry
- - see merge_bathy.f90 to merge fine grid bathymetry
- - see create_restart.f90 to create initial state file, or other fields.
- - see create_boundary.F90 to create boundary condition
+ @section howto How to use
+   @subsection howto_coord to create fine grid coordinate file
+   see create_coord.f90
+   @subsection howto_bathy to create fine grid bathymetry
+   see create_bathy.f90
+   @subsection howto_merge to merge fine grid bathymetry
+   see merge_bathy.f90
+   @subsection howto_restart to create initial state file
+   see create_restart.f90
+   @subsection howto_boundary to create boundary condition
+   see create_boundary.f90
 
 <HR>
    <b>
    - @ref md_docsrc_1_install
-   - @ref md_docsrc_2_quickstart
-   - @ref md_docsrc_3_support_bug
-   - @ref md_docsrc_4_codingRules
-   - @ref md_docsrc_5_changeLog
+   - @ref md_docsrc_3_codingRules
+   - @ref md_docsrc_4_changeLog
    - @ref todo
    </b>