Changeset 7877 for branches/UKMO/dev_r5518_test_GO6_package_update/NEMOGCM/TOOLS/SIREN/src

Timestamp:

2017-04-05T16:50:35+02:00 (7 years ago)

Author:

frrh

Message:

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.)

Location:

branches/UKMO/dev_r5518_test_GO6_package_update/NEMOGCM/TOOLS/SIREN/src/docsrc

Files:

• 1_install.md (modified) (1 diff)
• 2_quickstart.md (copied) (copied from branches/2015/nemo_v3_6_STABLE/NEMOGCM/TOOLS/SIREN/src/docsrc/2_quickstart.md)
• 3_support_bug.md (copied) (copied from branches/2015/nemo_v3_6_STABLE/NEMOGCM/TOOLS/SIREN/src/docsrc/3_support_bug.md)
• 4_codingRules.md (copied) (copied from branches/2015/nemo_v3_6_STABLE/NEMOGCM/TOOLS/SIREN/src/docsrc/4_codingRules.md)
• 5_changeLog.md (copied) (copied from branches/2015/nemo_v3_6_STABLE/NEMOGCM/TOOLS/SIREN/src/docsrc/5_changeLog.md)
• 6_perio.md (copied) (copied from branches/2015/nemo_v3_6_STABLE/NEMOGCM/TOOLS/SIREN/src/docsrc/6_perio.md)
• main.dox (modified) (1 diff)

branches/UKMO/dev_r5518_test_GO6_package_update/NEMOGCM/TOOLS/SIREN/src/docsrc/1_install.md

@@ -17 +17 @@
 <!--   - pgf95 (version 13.9-0) -->
 
- <HR>
-   <b>
-   - @ref index
-   - @ref md_docsrc_3_codingRules
-   - @ref md_docsrc_4_changeLog
-   - @ref todo
-   </b>
+# 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_src_docsrc_2_quickstart
+  - @ref md_src_docsrc_3_support_bug
+  - @ref md_src_docsrc_4_codingRules
+  - @ref md_src_docsrc_5_changeLog
+  - @ref todo
+  </b>

branches/UKMO/dev_r5518_test_GO6_package_update/NEMOGCM/TOOLS/SIREN/src/docsrc/main.dox

@@ -13 +13 @@
    - create_boundary.f90 to create boundary condition from coarse grid standard outputs.
 
-To install those programs see @ref md_docsrc_1_install.
+ SIREN is a software to set up regional configuration with [NEMO](http://www.nemo-ocean.eu).<br/> 
+ Actually SIREN creates the input files you need to run a NEMO regional configuration.<br/>
+ 
+ SIREN allows you to create your own regional configuration embedded in a wider one.<br/>
 
- @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)
+ To know how to install SIREN see @ref md_src_docsrc_1_install.
 
- @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
+ You could find a tutorial for a quick start with SIREN in @ref md_src_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
 
 <HR>
    <b>
-   - @ref md_docsrc_1_install
-   - @ref md_docsrc_3_codingRules
-   - @ref md_docsrc_4_changeLog
+   - @ref md_src_docsrc_1_install
+   - @ref md_src_docsrc_2_quickstart
+   - @ref md_src_docsrc_3_support_bug
+   - @ref md_src_docsrc_4_codingRules
+   - @ref md_src_docsrc_5_changeLog
    - @ref todo
    </b>