source: trunk/NEMOGCM/TOOLS/DOMAINcfg/README @ 7828

Last change on this file since 7828 was 7828, checked in by flavoni, 3 years ago

#1873, update ORCA2_LIM3_CONFIG, and open bathy_meter.nc

File size: 2.8 KB
Line 
1================================
2= HOW TO COMPILE
3================================
4The DOMAINcfg tool can be compiled using the maketools script in the NEMOGCM/TOOLS directory as follows:
5:::::::::::::::::::::::::::::::::
6./maketools -m $ARCH -n DOMAINcfg
7:::::::::::::::::::::::::::::::::
8where $ARCH indicates the arch file to be used from the directory NEMOGCM/ARCH.
9
10DOMAINcfg compiled will create "make_domain_cfg.exe" executable script (the main routine of this tool is make_domain_cfg.f90)
11
12================================
13= HOW TO RUN
14================================
15just run :
16:::::::::::::::::::::::::::::::::::::::::::::::::
17mpirun -np 1 ./make_domain_cfg.exe
18:::::::::::::::::::::::::::::::::::::::::::::::::
19NOTA: it can be run in multiproc mode, but in output there will be domain_cfg_00xx.nc files
20
21================================
22= HOW TO USE
23================================
24::: VERY IMPORTANT PRE-REQUIRED :::
250) pre-required: this tool needs xios1
26
27  (download http://forge.ipsl.jussieu.fr/ioserver/svn/XIOS/branchs/xios-1.0
28   DOMAINcfg tool is working with revision 703 of xios)
29
301) copy in DOMAINcfg  directory namelist_cfg all settings (that you had in 3.6_stable) of the configuration for which you want prepare domain_cfg.nc file
31IMPORTANT : keep the namelist_ref committed inchanged.
32
33NEW OPTION ln_e3_dep in the namelist_ref:
34till nemo_v3.6_stable e3 were done like an analytical derivative of depth function
35now  e3=dk[depth] in discret sens
36
37If you want to create same e3[tuvw] like 3.6 you've to use "ln_e3_dep=.false."
38
39 ln_e3_dep   = .true.    ! =T : e3=dk[depth] in discret sens.
40   !                       !      ===>>> will become the only possibility in v4.0
41   !                       ! =F : e3 analytical derivative of depth function
42   !                       !      only there for backward compatibility test with v3.6
43   !
44
452) copy in DOMAINcfg directory same input files (of related configuration) required in v3.6_stable.
46
47DOMAINcfg package is EXACTLY what does exist in NEMO version 3.6 to define a model domain (both domain related namelist and initialization).
48DOMAINcfg tool creates a netcdf file "domain_cfg.nc" containing all the ocean domain informations required to define an ocean configuration,
49these files are :
50         
51    domain size
52    domain characteristics (periodic)
53    horizontal mesh
54    Coriolis parameter
55    depth and vertical scale factors
56
57FOR EXAMPLE
58- for AMM12 :
59            coordinates.nc
60            bathy_meter.nc
61            bathy_level.nc
62            amm12_rivers.nc
63            coordinates.bdy.nc
64            amm12_restart_oce.nc
65         directories:   bdydta/
66                        fluxes/
67- for ORCA2 :
68            coordinates.nc
69            bathy_meter.nc
70            bathy_level.nc
71            domain_def.xml
72            field_def.xml
73            iodef.xml
Note: See TracBrowser for help on using the repository browser.