Changeset 9635 for NEMO/trunk/README-setup-configs

Timestamp:

2018-05-25T15:07:11+02:00 (7 years ago)

Author:

nicolasmartin

Message:

Reorganisation plan for NEMO repository: reinstate test cases in the trunk under './tests' root folder
In order to be clear, the development of the test cases is back to the trunk but the official hub for
the NEMO demonstration cases will be on Github (​https://github.com/sflavoni/NEMO-test-cases)
As a result, when we will set the new release, 'tests' will be emptied and
the last developements will be copied to the Github repository.

Other changes:

• README-setup-configs edited for path changes and moved to the root
• cfg.txt renamed to ref_cfgs.txt
• uspcfg.txt renamed to rmt_cfgs.txt ('rmt' for remote) and moved to ./tests
• makenemo will create new configuration using work_cfgs.txt file, this file will be ignored by SVN thanks to svn:ignore property set

File:

• NEMO/trunk/README-setup-configs (moved) (moved from NEMO/trunk/cfgs/README-setup-configs) (3 diffs)

NEMO/trunk/README-setup-configs

@@ -6 +6 @@
 In NEMO 4.0 two types of configurations can be build: global/regional and idealized.
 
-- create NEMOGCM/CONFIG/your_config
+- create ./cfgs/your_config
 - case 1: regional or global 
-    => ln_read_cfg = .true. in NEMOGCM/CONFIG/your_config/EXP00/namelist_cfg (i.e. read domain_cfg.nc)
+    => ln_read_cfg = .true. in ./cfgs/your_config/EXP00/namelist_cfg (i.e. read domain_cfg.nc)
 - case 2: idealized 
-    =>in NEMOGCM/CONFIG/your_config/EXP00/namelist_cfg :
+    =>in ./cfgs/your_config/EXP00/namelist_cfg :
       ln_read_cfg = .false. (need to define usrdef_hgr.F90 and usrdef_zgr.F90) 
       ln_usr = .true.       (need to define usrdef_sbc.F90)    
-    => copy NEMOGCM/NEMO/OCE_SRC/USR in NEMOGC/CONFIG/your_config/MY_SRC routines nedeed to set up domain, forcing fields and initial state
+    => copy ./src/OCE/USR in ./cfgs/your_config/MY_SRC routines nedeed to set up domain, forcing fields and initial state
     
-  Routines in NEMOGCM/NEMO/OCE_SRC/USR define analytically the domain, the initial state and the surface boundary conditions for the reference configuration GYRE.
+  Routines in NEMOGCM/NEMO/OCE/USR define analytically the domain, the initial state and the surface boundary conditions for the reference configuration GYRE.
      •   usrdef_hgr.F90 and usrdef_zgr.F90 : define horizontal and vertical grid
      •   usrdef_sbc.F90    : provides at each time-step the surface boundary condition, i.e. the momentum, heat and freshwater fluxes
@@ -23 +23 @@
      •   usrdef_nam.F90    : set the domain characteristics of a user configuration
 
-  Other analytical examples are given in NEMOGCM/CONFIG/TEST_CASES.
+  Other analytical examples are given in ./tests.
 
 ===========================================
@@ -51 +51 @@
  - users can create with his own tool the domain_cfg.nc with all mandatory fields.  
 
- - tool is available in NEMOGCM/TOOLS/DOMAINcfg based on NEMO 3.6 version. See NEMOGCM/TOOLS/DOMAINcfg/README.
+ - tool is available in ./tools/DOMAINcfg based on NEMO 3.6 version. See ./tools/DOMAINcfg/README.