New URL for NEMO forge!   http://forge.nemo-ocean.eu

Since March 2022 along with NEMO 4.2 release, the code development moved to a self-hosted GitLab.
This present forge is now archived and remained online for history.
2_quickstart.md in branches/2016/dev_r6999_CONFIGMAN_1/NEMOGCM/TOOLS/SIREN/src/docsrc – NEMO

source: branches/2016/dev_r6999_CONFIGMAN_1/NEMOGCM/TOOLS/SIREN/src/docsrc/2_quickstart.md @ 7025

Last change on this file since 7025 was 7025, checked in by jpaul, 8 years ago

see ticket #1781

File size: 23.7 KB
Line 
1# How To Use (Quick Start)
2
3@tableofcontents
4
5SIREN is a software to set up regional configuration with
6 [NEMO](http://www.nemo-ocean.eu).<br/>
7Actually SIREN creates all the input files you need to run a NEMO regional configuration.<br/>
8 
9SIREN is composed of a set of 6 Fortran programs :
10<ul>
11 <li>create_coord.f90 to create regional grid coordinates.</li>
12 <li>create_bathy.f90 to create regional grid bathymetry.</li>
13 <li>merge_bathy.f90 to merge regional grid bathymetry with wider grid bathymetry
14 at boundaries.
15 @note the goal of this step is to avoid break in Bathymetry.
16 This break may cause inconsistency between forcing fields  at boundary and regional fields.
17 </li>
18 <li>create_meshmask.f90 to create meshmask file(s) which contain(s) all the ocean domain informations.</li>
19 <li>create_restart.f90 to create initial state file from coarse grid restart
20 or standard outputs.
21 @note this program could also be used to refined other input fields from a wider
22 configuations (as runoff, chlorophyll etc...)
23 </li>
24 <li>create_boundary.F90 to create boundaries conditions from wider configurations
25 output fields.
26 </li>
27</ul>
28
29@warning SIREN can not:
30<ul>
31<li>create global configuration.</li>
32<li>create configuarion around or close to North pole.</li>
33<li>change number of vertical level.</li>
34</ul>
35
36Here after we briefly describe how to use each programs,
37and so how to create your own regional configuration.
38@note As demonstrator for a first start a set of GLORYS files (global reanalysis on *ORCA025* grid), as well as examples of namelists are available [here](https://cloud.mercator-ocean.fr/public.php?service=files&t=877fb1b6e4f589340fc0df1ea6a53228).
39
40<!-- ######################################################################  -->
41# Create coordinates file # {#coord}
42
43To create your own configuration, you first have to create a coordinates file on your domain of study.<br/>
44SIREN allows you to create this coordinates file from a wider coordinates file.<br/>
45The coordinates file created could simply be an extraction, or a refinment of
46the wide grid.<br/>
47
48To create this new cooridnates file, you have to run :
49~~~~~~~~~~~~~~~~~~
50./SIREN/create_coord.exe create_coord.nam
51~~~~~~~~~~~~~~~~~~
52
53Here after is an example of namelist for *create_coord.exe*.<br/>
54In this example, you create a coordinates file named *coord_fine.nc*.<br/>
55This new coordinates file is refined from an extraction of *coordinates_ORCA025.nc*.
56~~~~~~~~~~~
57&namlog
58/
59
60&namcfg
61   cn_varcfg = "PATH/NEMOGCM/TOOLS/SIREN/cfg/variable.cfg"
62/
63
64&namcrs
65   cn_coord0 = "PATH/coordinates_ORCA025.nc"
66   in_perio0 = 4
67/
68
69&namvar
70/
71
72&namnst
73   in_imin0 = 1070
74   in_imax0 = 1072
75   in_jmin0 = 607
76   in_jmax0 = 609
77
78   in_rhoi = 2
79   in_rhoj = 3
80/
81
82&namout
83   cn_fileout = "PATH/coord_fine.nc"
84/
85~~~~~~~~~~~
86
87Let's get describe this namelist.<br/>
88First we have the **namlog** sub-namelist. This sub-namelist set parameters of the log
89file.<br/>
90All the parameters of this sub-namelist have default value, so you could let it
91empty, as done here.<br/> This will create a log file named *create_coord.log*
92
93The **namcfg** sub-namelist defines where found SIREN configuration file.<br/>
94This configuration file defines standard name, default interpolation method,
95axis,... to be used for some known variables.<br/>
96Obviously, you could add other variables to those already list, in this file.
97
98@note You could find the generic version of *variable.cfg* in the directory *NEMOGCM/TOOLS/SIREN/cfg*.
99
100The **namcrs** sub-namelist set parameters of the wide
101coordinates file,<br/> as path to find it, and NEMO periodicity of the wide grid.<br/>
102
103@note the NEMO periodicity could be choose between 0 to 6:
104<dl>
105<dt>in_perio=0</dt>
106<dd>standard regional model</dd>
107<dt>in_perio=1</dt>
108<dd>east-west cyclic model</dd>
109<dt>in_perio=2</dt>
110<dd>model with symmetric boundary condition across the equator</dd>
111<dt>in_perio=3</dt>
112<dd>regional model with North fold boundary and T-point pivot</dd>
113<dt>in_perio=4</dt>
114<dd>global model with a T-point pivot.<br/>
115example: ORCA2, ORCA025, ORCA12</dd>
116<dt>in_perio=5</dt>
117<dd>regional model with North fold boundary and F-point pivot</dd>
118<dt>in_perio=6</dt>
119<dd>global model with a F-point pivot<br/>
120example: ORCA05</dd>
121</dl>
122@sa For more information see @ref md_src_docsrc_6_perio
123</dd>
124</dl>
125
126The **namvar** sub-namelist lists variables to be used.<br/>
127By default all the variables of the wider coordinates file are used to create
128the new coordinates file.<br/>
129The interpolation methods to be used are defined in the configuration variables file (see
130below). So you do not need to fill this sub-namelist too.
131
132The **namnst** sub-namelist defines the subdomain to be used as well as refinment factor.<br/>
133@note Subdomain is defined by indices of the coarse/wide grid.<br/>
134
135<ul>
136<li>you can select area quite every where (excepted too close from the North
137pole), and use the refinment factor you want.</li>
138
139~~~~~~~~~~~
140&namvar
141   in_imin0 = 1070
142   in_imax0 = 1072
143   in_jmin0 = 607
144   in_jmax0 = 609
145
146   in_rhoi = 2
147   in_rhoj = 3
148/
149~~~~~~~~~~~
150@image html grid_zoom_60.png
151<center>@image latex grid_zoom_40.png
152</center>
153<!-- @note ghost cells all around the grid are not shown here. -->
154
155<li>you can select area crossing the east-west overlap of the global ORCA grid.</li>
156
157~~~~~~~~~~~
158&namvar         
159   in_imin0 = 1402
160   in_imax0 = 62
161   in_jmin0 = 490
162   in_jmax0 = 570
163
164   in_rhoi = 5
165   in_rhoj = 5
166/               
167~~~~~~~~~~~
168@image html grid_glob_over_30.png
169<center>@image latex grid_glob_over_20.png
170</center>
171<!-- @note in blue, the east-west overlap band of ORCA grid. -->
172
173<li>you can select east-west cyclic area.</li>
174
175~~~~~~~~~~~
176&namvar
177   in_imin0 = 0
178   in_imax0 = 0
179   in_jmin0 = 390
180   in_jmax0 = 450
181
182   in_rhoi = 1
183   in_rhoj = 1
184/
185~~~~~~~~~~~
186@image html grid_glob_band_30.png
187<center>@image latex grid_glob_band_20.png
188</center>
189
190</ul>
191
192Finally the **namout** sub-namelist defines the output file.<br/>
193
194@note All the output files created by SIREN include information about NEMO
195periodicity, as well as source file, indices and refinment used.
196
197@sa For more information about how to create coordinates, see create_coord.f90
198
199<!-- ######################################################################  -->
200# Create bathymetry file # {#bathy}
201
202Then you need a Bathymetry file.<br/>
203SIREN allows you to create a Bathymetry extracted or refined from a wider
204Bathymetry grid.<br/>
205
206To create this new bathymetry, you have to run :
207~~~~~~~~~~~~~~~~~~
208./SIREN/create_bathy.exe create_bathy.nam
209~~~~~~~~~~~~~~~~~~
210
211Here after is an example of namelist for *create_bathy.exe*.<br/>
212In this example, you create a bathymetry file named *bathy_fine.nc*.<br/>
213This new bathymetry file is refined from an extraction of *bathy_meter_ORCA025.nc*.<br/>
214Moreover a minimum value of 5m is imposed to the output Bathymetry.
215~~~~~~~~~~~~~~~~~~
216&namlog
217/
218
219&namcfg
220   cn_varcfg = "PATH/NEMOGCM/TOOLS/SIREN/cfg/variable.cfg"
221/
222
223&namcrs
224   cn_coord0 = "PATH/coordinates_ORCA025.nc"
225   in_perio0 = 4
226/
227
228&namfin
229   cn_coord1 = "PATH/coord_fine.nc"
230/
231
232&namvar
233   cn_varfile = "Bathymetry:PATH/bathy_meter_ORCA025.nc"
234   cn_varinfo = "Bathymetry: min=5"
235/
236
237&namnst
238   in_rhoi = 2
239   in_rhoj = 3
240/
241
242&namout
243   cn_fileout = "PATH/bathy_fine.nc"     
244/
245~~~~~~~~~~~~~~~~~~
246
247Let's get describe this namelist.<br/>
248
249First as previously, we have the **namlog** and **namcfg** sub-namelist (see above for more
250explanation).<br/>
251
252Then the **namcrs** sub-namelist set parameters of the wide
253coordinates file.<br/>
254@note in all SIREN namelist: <br/>
2550 referred to the coarse/wide grid.<br/>
2561 referred to the fine grid.
257
258In the same way, the **namfin** sub-namelist  set parameters of the fine
259coordinates file.<br/>
260@note in this namelist example, there is no need to set the variable *in_perio1* to define the NEMO
261periodicity of the fine grid.<br/> Indeed, if this variable is not inform, SIREN tries to read it in the attributes of the file.<br/>
262So if you created the fine coordinates with SIREN, you do not have to
263fill it. In other case, you should add it to the namelist.
264
265The **namvar** sub-namelist lists variables to be used:
266<dl>
267   <dt>cn_varfile</dt>
268      <dd> defines the variable name ("Bathymetry" here) and the input file associated with.
269            @warning The domain of the input Bathymetry have to be larger than the output domain.
270         @note
271         <ul>
272            <li>if the input file is at coarse grid resolution (same than *cn_coord0*), the ouptut Bathymetry will be refined on fine grid.</li>
273            <li>if the input file is a wider bathymetry (already at fine grid resolution), the output Bathymetry will be extracted from this one.</li>
274         </ul>
275      </dd>
276   <dt>cn_varinfo</dt>
277      <dd> defines user's requests for a variable.
278         @note Default interpolation method for the Bathymetry, is *cubic* interpolation.<br/>
279         So you may want to specify a minimum value to avoid negative value, or to change interpolation method.<br/>
280         example: <ul><li>cn_varinfo="Bathymetry: min=1"'</li>
281                      <li>cn_varinfo="Bathymetry: int=linear"</li></ul>
282      </dd>
283</dl>
284
285The **namnst** sub-namelist defines the subdomain refinment factor.<br/>
286Of course those refinment factors have to be convenient with refinment
287from coarse grid *cn_coord0* to fine grid *cn_coord1*.
288@note subdomain indices are automatically deduced from fine and coarse grid
289coordinates.
290
291Finally, this **namout** sub-namelist defines the output file.<br/>
292
293@note All the output files create by SIREN include information about
294source file, indices, refinment and interpolation method used.
295
296@sa For more information about how to create bathymetry, see
297create_bathy.f90
298
299<!-- ######################################################################  -->
300# Merge bathymetry file # {#merge}
301
302The Bathymetry you build differs from the wider one.<br/>
303To avoid issue with boundaries forcing fields, you should merge fine and coarse Bathymetry on boundaries.<br/>
304SIREN allows you to do this.<br/>
305
306To create this merged bathymetry, you have to run :
307~~~~~~~~~~~~~~~~~~
308./SIREN/merge_bathy.exe merge_bathy.nam
309~~~~~~~~~~~~~~~~~~
310
311Here after is an example of namelist for *merge_bathy.exe*.<br/>
312~~~~~~~~~~~~~~~~~~
313&namlog
314/
315
316&namcfg
317   cn_varcfg = "PATH/NEMOGCM/TOOLS/SIREN/cfg/variable.cfg"
318/
319
320&namcrs
321   cn_bathy0 = "PATH/bathy_meter_ORCA025.nc"
322   in_perio0 = 4
323/
324
325&namfin
326   cn_bathy1 = "PATH/bathy_fine.nc"
327/
328
329&namnst
330   in_rhoi = 3
331   in_rhoj = 3
332/
333
334&nambdy
335/
336
337&namout
338   cn_fileout = "PATH/bathy_merged.nc"     
339/
340~~~~~~~~~~~~~~~~~~
341In this namelist, you find again the **namlog**, **namcfg** describe above.
342
343Then the **namcrs** sub-namelist sets parameters of the wider grid.
344However this time, this is the coarse/wide grid Bathymetry wich have to be informed.
345
346The **namfin** sub-namelist defines parameters of the fine grid Bathymetry.
347@note here again you could add the *in_perio1* parameter if need be i.e. if your
348fine grid Bathymetry was not created by SIREN.
349
350The **namnst** sub-namelist defines the subdomain refinment factor.
351
352
353The **nambdy** sub-namelist defines the subdomain boundaries.<br/>
354By default SIREN tries to create boundaries for each side. Boundary exist if there is at least one sea point on the second row of each side.<br/>
355So you could let this namelist empty.
356
357@sa For more information about boundaries, see @ref boundary
358
359Finally, this **namout** sub-namelist defines the output file.<br/>
360
361@sa For more information about how to merge bathymetry, see
362merge_bathy.f90
363
364<!-- ######################################################################  -->
365# Create meshmask (ocean domain informations) # {#meshmask}
366
367
368Depending on the vertical grid you choose to use, NEMO may not see the bathymetry as you defined it just before. To get the ocean domain informations as seen by NEMO, SIREN allows you to create the meshmask file(s) which contain(s) all those informations.
369
370To create this new meshmask file(s), you have to run :
371~~~~~~~~~~~~~~~~~~
372./SIREN/create_meshmask.exe create_meshmask.nam
373~~~~~~~~~~~~~~~~~~
374
375Here after is an example of namelist for *create_meshmask.exe*.<br/>
376In this example, you create one meshmask file named *mesh_mask.nc*.<br/>
377It uses coordinates file *coord_fine.nc* to define horizontal grid.
378and defines z-coordinate with partial steps.
379The minimum depth of the final Bathymetry is 10m.
380~~~~~~~~~~~
381&namlog
382/
383
384&namcfg
385   cn_varcfg = "PATH/NEMOGCM/TOOLS/SIREN/cfg/variable.cfg"
386/
387
388&namin
389   cn_bathy = "PATH/bathy_merged.nc"
390   cn_coord = "PATH/coord_fine.nc"
391   in_perio = 4
392/
393
394&namhgr
395   in_mshhgr = 0
396/
397
398&namzgr
399   ln_zps   = .TRUE.
400   in_nlevel= 75
401/
402
403&namdmin
404   dn_hmin=10.
405/
406
407&namzco
408   dn_ppsur   = -3958.951371276829
409   dn_ppa0    =   103.953009600000
410   dn_ppa1    =     2.415951269000
411   dn_ppkth   =    15.351013700000
412   dn_ppacr   =     7.000000000000
413   dn_ppdzmin = 6.
414   dn_pphmax  = 5750.
415   ln_dbletanh= .TRUE.
416   dn_ppa2    =   100.760928500000
417   dn_ppkth2  =    48.029893720000
418   dn_ppacr2  =    13.000000000000
419/
420
421&namzps
422   dn_e3zps_min = 25.
423   dn_e3zps_rat = 0.2
424/
425
426&namsco
427/
428
429&namcla
430/
431
432&namlbc
433/
434
435&namwd
436/
437
438&namgrd
439/
440
441&namzoom
442/
443
444&namout
445   in_msh = 1
446/
447~~~~~~~~~~~
448
449Let's get describe this namelist more accurately.<br/>
450
451As previously, we have the **namlog** and **namcfg** describe above.<br/>
452
453The **namin** sub-namelist defines the Bathymetry to be used.
454Mainly SIREN need Bathymetry to create meshmask.
455Here we also read coordinates directly on a file.
456@note here again you could add the *in_perio* parameter if need be i.e. if your
457Bathymetry was not created by SIREN.<br/>
458@note By default SIREN suppress closed sea/lake from the ORCA domain.
459
460The **namhgr** sub-namelist defines the horizontal grid.
461the type of horizontal mesh is choose between :<ul>
462<li> in_mshhgr=0 : curvilinear coordinate on the sphere read in coordinate.nc</li>
463<li> in_mshhgr=1 : geographical mesh on the sphere with regular grid-spacing</li>
464<li> in_mshhgr=2 : f-plane with regular grid-spacing</li>
465<li> in_mshhgr=3 : beta-plane with regular grid-spacing</li>
466<li> in_mshhgr=4 : Mercator grid with T/U point at the equator</li>
467<li> in_mshhgr=5 : beta-plane with regular grid-spacing and rotated domain (GYRE configuration)</li>
468</ul>
469
470The **namzgr** sub-namelist allows to choose the type of vertical grid (z-coordinate full steps, partial steps, sigma or hybrid coordinates) and the number of level.
471
472The **namdmin** sub-namelist dfines the minimum ocean depth. It could be defines in meter (>0) or in number of level (<0).
473
474The **namzco** sub-namelist defines respectively parameters to compute z-coordinate vertical grid (**needed for all type of vertical grid**)
475<!-- By default, those parameters are defined the same way than in GLORYS (i.e. 75 vertical levels).<br/> -->
476
477The **namzps** sub-namelist defines extra parameters needed to define z-coordinates partial steps.
478
479The **namsco** sub-namelist defines extra parameters needed to define sigma or hybrid coordinates (not needed here).
480
481The **namcla** sub-namelist defines cross land advection for exchanges through some straits only used for ORCA2 (see namgrd).
482
483The **namlbc** sub-namelist defines lateral boundary conditions at the coast. It is needed to modify the fmask.
484
485The **namwd** sub-namelist defines the wetting and drying parameters if activated (see namzgr sub-namelist)
486
487The **namgrd** and **namzoom** sub-namelists define grid configuration. Those namelist only activated local correction.
488
489Finally, this **namout** sub-namelist defines the number output file(s).<br/>
490
491@sa For more information about how to create meshmask, see create_meshmask.f90
492
493<!-- ######################################################################  -->
494# Create initial state # {#restart}
495
496To run your configuration you need an inital state of the ocean.<br/>
497You could start from a restart file (with all NEMO variables fields at one
498time step). Or you could start from "partial" information about ocean state (Temperature and Salinity for example).
499
500Siren allows you to create both of those initial state.<br/>
501To create the initial state, you have to run:<br/>
502~~~~~~~~~~~~~~~~~~
503./SIREN/create_restart.exe create_restart.nam
504~~~~~~~~~~~~~~~~~~
505
506Here after is an example of namelist for *create_restart.exe*.<br/>
507In this example, you create an initial state split on 81 "processors", and named restar_out.nc.<br/>
508The initial state is composed of temperature and salinity refined from an extraction of GLORYS fields.
509~~~~~~~~~~~~~~~~~~
510&namlog
511/
512
513&namcfg
514   cn_varcfg = "PATH/NEMOGCM/TOOLS/SIREN/cfg/variable.cfg"
515/
516
517&namcrs
518   cn_coord0 = "PATH/coordinates_ORCA025.nc"
519   in_perio0 = 4
520/
521
522&namfin
523   cn_coord1 = "PATH/coord_fine.nc"
524   cn_bathy1 = "PATH/bathy_merged.nc"
525/
526
527&namzgr
528/
529
530&namzps
531/
532
533&namvar
534   cn_varfile = "votemper:GLORYS_gridT.nc",
535                "vosaline:GLORYS_gridS.nc"
536/
537
538&namnst
539   in_rhoi = 3
540   in_rhoj = 3
541/
542
543&namout
544   cn_fileout = "PATH/restart_out.nc"     
545   in_nproc = 81
546/
547~~~~~~~~~~~~~~~~~~
548Let's get describe this namelist more accurately.<br/>
549
550As previously, we have the **namlog** and **namcfg** sub-namelists, as well as
551the **namcrs** sub-namelist to set parameters of the wide coordinates file (see above for more
552explanation).<br/>
553
554Then the **namfin** sub-namelist set parameters of the fine
555grid coordinates and bathymetry.<br/>
556
557The **namzgr** and **namzps** sub-namelists define respectively parameters for vertical grid
558and partial step.<br>
559By default, those parameters are defined the same way than in GLORYS (i.e. 75 vertical levels).<br/>
560So you could let it empty.
561@note If you use forcing fields other than GLORYS, you have to be sure it uses the same vertical grid. In other case, you need to get information about the parametrisation use, and to put it in those sub-namelist (see create_restart.f90).
562
563the **namvar** sub-namelist lists variables to be used.<br/>
564Here we use *votemper* (temperature) get from *GLORYS_gridT.nc* file, and *vosaline*
565(salinity) get from *GLORYS_gridS.nc* file.
566@note To get all variables of a restart file. You have to use:
567~~~~~~~~~~~~~~~~~~
568cn_varfile = "all:PATH/restart.dimg"
569~~~~~~~~~~~~~~~~~~
570
571The **namnst** sub-namelist defines the subdomain refinment factor, as seen previously.<br/>
572
573Finally, this **namout** sub-namelist defines the output files.<br/>
574Here we ask for output on 81 processors, with *restart_out.nc* as file "basename".<br/>
575So SIREN computes the optimal layout for 81 processors
576available,<br/>
577and split restart on output files named *restart_out_num.nc*, where *num* is the proc number.
578
579@note SIREN could also create the other fields you may need for
580your configuration.<br/>
581To do so, you just have to run *create_restart.exe* with other variable(s) from other input file(s).<br/>
582For example, to get runoff fields, you could use:
583~~~~~~~~~~~~~~~~~~
584cn_varfile = "sorunoff:PATH/runoff_GLORYS.nc"
585...
586cn_fileout = "PATH/runoff_out.nc"
587~~~~~~~~~~~~~~~~~~
588
589@sa For more information about how to create initial state or other fields, see
590create_restart.f90
591
592<!-- ######################################################################  -->
593# Create boundaries conditions # {#boundary}
594
595Finally to force your configuration, you may need boundaries conditions.<br/>
596NEMO read physical boundaries conditions from temperature, salinity, currents, and sea
597surface height.
598
599To create the boundaries condition with SIREN, you have to run:<br/>
600~~~~~~~~~~~~~~~~~~
601./SIREN/create_boundary.exe create_boundary.nam
602~~~~~~~~~~~~~~~~~~
603
604Here after is an example of namelist for *create_boundary.exe*.<br/>
605In this example, you create boundaries conditions named *boundary_out.nc* on
606each side of the domain.<br/>
607The boundaries contain information about temperature, salinity, currents and sea surface height refined from an extraction of GLORYS fields.
608~~~~~~~~~~~~~~~~~~
609&namlog
610/
611
612&namcfg
613   cn_varcfg = "PATH/NEMOGCM/TOOLS/SIREN/cfg/variable.cfg"
614/
615
616&namcrs
617   cn_coord0 = "PATH/coordinates_ORCA025.nc"
618   in_perio0 = 4
619/
620
621&namfin
622   cn_coord1 = "PATH/coord_fine.nc"
623   cn_bathy1 = "PATH/bathy_fine.nc"
624/
625
626&namzgr
627/
628
629&namzps
630/
631
632&namvar
633   cn_varfile="votemper:GLORYS_gridT.nc",
634              "vosaline:GLORYS_gridS.nc",
635              "vozocrtx:GLORYS_gridU.nc",
636              "vomecrty:GLORYS_gridV.nc",
637              "sossheig:GLORYS_grid2D.nc"
638/
639
640&namnst
641   in_rhoi = 3
642   in_rhoj = 3
643/
644
645&nambdy
646/
647
648&namout
649   cn_fileout = "PATH/boundary_out.nc"     
650/
651~~~~~~~~~~~~~~~~~~
652
653Let's get describe this namelist more accurately.<br/>
654
655As previously, we have the **namlog** and **namcfg** sub-namelists, as well as
656the **namcrs** sub-namelist to set parameters of the wide coordinates file (see above for more
657explanation).<br/>
658
659Then the **namfin** sub-namelist set parameters of the fine
660grid coordinates and bathymetry.<br/>
661
662The **namzgr** and **namzps** sub-namelists define respectively parameters for vertical grid
663and partial step.<br>
664By default, those parameters are defined the same way than in GLORYS (i.e. 75 vertical levels).<br/>
665So you could let it empty.
666@note If you use forcing fields other than GLORYS, you have to be sure it uses the same vertical grid. In other case, you need to get information about the parametrisation use, and to put it in those sub-namelist (see create_boundary.F90).
667
668the **namvar** sub-namelist lists variables to be used.<br/>
669Here we get *votemper* (temperature) from *GLORYS_gridT.nc* file, *vosaline*
670(salinity) from *GLORYS_gridS.nc* file, *vozocrtx* (zonal velocity) from
671*GLORYS_gridU.nc*, *vomecrty* (meridional velocity) from *GLORYS_gridV.nc*, and sossheig (sea surface
672height) from *GLORYS_grid2D.nc*.
673
674The **namnst** sub-namelist defines the subdomain refinment factor.<br/>
675
676The **nambdy** sub-namelist defines the subdomain boundaries.<br/>
677By default SIREN tries to create boundaries for each side (Boundary is created if sea point exist on the second row of each side).<br/>
678So you could let this namelist empty.
679
680@note SIREN allows you to place boundaries away from the side of the domain.
681To do so you have to define your boundary.<br/>
682That means you have to give on fine
683grid the index of the boundary (how far from the border your boundary is),
684the width of your boundary, and finally first and last point of your boundary (the length of your boundary).<br/>
685So to define a north boundary, you have to add in the sub-namelist *nambdy*, the parameter:
686~~~~~~~~~~~~~~~~~~
687cn_north="index,first:last(width)"
688~~~~~~~~~~~~~~~~~~
689
690Finally, this **namout** sub-namelist defines the output files.<br/>
691Here we ask for output with *boundary_out.nc* as file "basename".<br/>
692So SIREN creates output files named *boundary_out_west.nc*,
693*boundary_out_east.nc*, *boundary_out_north.nc*, and *boundary_out_south.nc*
694depending if boundary exist or not.
695
696@sa For more information about how to create boundaries condition, see
697create_boundary.F90
698
699# Create and run NEMO configuration # {#NEMOconf}
700
701So now you created all the input files you need for your physical configuration, you have to create the "NEMO configuration".<br/>
702To do so, go to the directory *NEMOGCM/CONFIG/*, and run:
703~~~~~~~~~~~~~~~~~~
704./makenemo -n MY_CONFIG -d "OPA_SRC"
705~~~~~~~~~~~~~~~~~~
706This creates your configuration "MY_CONFIG" in the directory *NEMOGCM/CONFIG*.<br/>
707you could check the cpp_keys used in file *cpp_MY_CONFIG.fcm*, and re-run *makenemo*
708if need be.
709
710Once *makenemo* has run successfully, the *opa* executable is available in
711directory *NEMOGCM/CONFIG/MY_CONFIG/EXP00*.<br/>
712Then you just have to put all your input files in this directory, fill the namelist *namelist_cfg*, and run:
713~~~~~~~~~~~~~~~~~~
714mpirun ./opa
715~~~~~~~~~~~~~~~~~~
716
717@note no surface forcing here.
718weighted function needed to do interpolation on the fly, could be created by WEIGHT tools already inside NEMO.
719
720@sa For more information about how to create NEMO configuration see [NEMO Quick Start Guide](http://www.nemo-ocean.eu/Using-NEMO/User-Guides/Basics/NEMO-Quick-Start-Guide).
721
722 <HR>
723   <b>
724   - @ref index
725   - @ref md_src_docsrc_1_install
726   - @ref md_src_docsrc_2_quickstart
727   - @ref md_src_docsrc_3_support_bug
728   - @ref md_src_docsrc_4_codingRules
729   - @ref md_src_docsrc_5_changeLog
730   - @ref todo
731   </b>
Note: See TracBrowser for help on using the repository browser.