Changeset 10115 for NEMO/branches/2018/dev_r5003_MERCATOR6_CRS/NEMOGCM/TOOLS/SIREN/src/docsrc/2_quickstart.md
- Timestamp:
- 2018-09-12T15:59:13+02:00 (6 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
NEMO/branches/2018/dev_r5003_MERCATOR6_CRS/NEMOGCM/TOOLS/SIREN/src/docsrc/2_quickstart.md
r7261 r10115 59 59 &namcfg 60 60 cn_varcfg = "PATH/NEMOGCM/TOOLS/SIREN/cfg/variable.cfg" 61 cn_dimcfg = "PATH/NEMOGCM/TOOLS/SIREN/cfg/dimension.cfg" 61 62 / 62 63 … … 83 84 / 84 85 ~~~~~~~~~~~ 86 87 @note you could define sub domain with coarse grid indices or with coordinates. 85 88 86 89 Let's get describe this namelist.<br/> … … 90 93 empty, as done here.<br/> This will create a log file named *create_coord.log* 91 94 92 The **namcfg** sub-namelist defines where found SIREN configuration file .<br/>93 Thisconfiguration file defines standard name, default interpolation method,95 The **namcfg** sub-namelist defines where found SIREN configuration files.<br/> 96 - The variable configuration file defines standard name, default interpolation method, 94 97 axis,... to be used for some known variables.<br/> 95 98 Obviously, you could add other variables to those already list, in this file. 96 97 @note You could find the generic version of *variable.cfg* in the directory *NEMOGCM/TOOLS/SIREN/cfg*. 99 - The dimension configuration file defines dimensions allowed. 100 101 @note You could find the generic version of those configuration files in the directory *NEMOGCM/TOOLS/SIREN/cfg*. 98 102 99 103 The **namcrs** sub-namelist set parameters of the wide 100 coordinates file, <br/>as path to find it, and NEMO periodicity of the wide grid.<br/>104 coordinates file, as path to find it, and NEMO periodicity of the wide grid.<br/> 101 105 102 106 @note the NEMO periodicity could be choose between 0 to 6: … … 130 134 131 135 The **namnst** sub-namelist defines the subdomain to be used as well as refinment factor.<br/> 132 @note Subdomain is defined by indices of the coarse/wide grid.<br/>133 136 134 137 <ul> 135 <li>you can select area quite every where (excepted too close from the North 136 pole), and use the refinment factor you want.</li> 137 138 ~~~~~~~~~~~ 139 &namvar 138 <li> you could define sub domain with coarse grid indices</li> 139 140 ~~~~~~~~~~~ 141 &namnst 140 142 in_imin0 = 1070 141 143 in_imax0 = 1072 142 144 in_jmin0 = 607 143 145 in_jmax0 = 609 146 / 147 ~~~~~~~~~~~ 148 149 <li>or with coordinates</li> 150 151 ~~~~~~~~~~~ 152 &namnst 153 rn_lonmin0 = -97.9 154 rn_lonmax0 = -62.3 155 rn_latmin0 = 7.7 156 rn_latmax0 = 30.8 157 / 158 ~~~~~~~~~~~ 159 160 <li>you can select area quite every where (excepted too close from the North 161 pole), and use the refinment factor you want.</li> 162 163 ~~~~~~~~~~~ 164 &namnst 165 in_imin0 = 1070 166 in_imax0 = 1072 167 in_jmin0 = 607 168 in_jmax0 = 609 144 169 145 170 in_rhoi = 2 … … 148 173 ~~~~~~~~~~~ 149 174 @image html grid_zoom_60.png 150 @image latex grid_zoom_40.png 175 <center>@image latex grid_zoom_40.png 176 </center> 151 177 <!-- @note ghost cells all around the grid are not shown here. --> 152 178 179 180 153 181 <li>you can select area crossing the east-west overlap of the global ORCA grid.</li> 154 182 155 183 ~~~~~~~~~~~ 156 &nam var184 &namnst 157 185 in_imin0 = 1402 158 186 in_imax0 = 62 … … 165 193 ~~~~~~~~~~~ 166 194 @image html grid_glob_over_30.png 167 @image latex grid_glob_over_20.png 195 <center>@image latex grid_glob_over_20.png 196 </center> 168 197 <!-- @note in blue, the east-west overlap band of ORCA grid. --> 169 198 … … 171 200 172 201 ~~~~~~~~~~~ 173 &nam var202 &namnst 174 203 in_imin0 = 0 175 204 in_imax0 = 0 … … 182 211 ~~~~~~~~~~~ 183 212 @image html grid_glob_band_30.png 184 @image latex grid_glob_band_20.png 213 <center>@image latex grid_glob_band_20.png 214 </center> 185 215 186 216 </ul> … … 215 245 &namcfg 216 246 cn_varcfg = "PATH/NEMOGCM/TOOLS/SIREN/cfg/variable.cfg" 247 cn_dimcfg = "PATH/NEMOGCM/TOOLS/SIREN/cfg/dimension.cfg" 217 248 / 218 249 … … 249 280 coordinates file.<br/> 250 281 @note in all SIREN namelist: <br/> 251 0referred to the coarse/wide grid.<br/>252 1referred to the fine grid.282 **0** referred to the coarse/wide grid.<br/> 283 **1** referred to the fine grid. 253 284 254 285 In the same way, the **namfin** sub-namelist set parameters of the fine 255 286 coordinates file.<br/> 256 287 @note in this namelist example, there is no need to set the variable *in_perio1* to define the NEMO 257 periodicity of the fine grid. <br/> Indeed, if this variable is not inform, SIREN tries to read it in the attributes of the file.<br/>258 So if you created the fine coordinates with SIREN, you do not have to288 periodicity of the fine grid. Indeed, if this variable is not inform, SIREN tries to read it 289 in the global attributes of the file. So if you created the fine coordinates with SIREN, you do not have to 259 290 fill it. In other case, you should add it to the namelist. 260 291 … … 296 327 # Merge bathymetry file # {#merge} 297 328 298 The Bathymetry you build differsfrom the wider one.<br/>329 The Bathymetry you build, may differ from the wider one.<br/> 299 330 To avoid issue with boundaries forcing fields, you should merge fine and coarse Bathymetry on boundaries.<br/> 300 331 SIREN allows you to do this.<br/> … … 312 343 &namcfg 313 344 cn_varcfg = "PATH/NEMOGCM/TOOLS/SIREN/cfg/variable.cfg" 345 cn_dimcfg = "PATH/NEMOGCM/TOOLS/SIREN/cfg/dimension.cfg" 314 346 / 315 347 … … 348 380 349 381 The **nambdy** sub-namelist defines the subdomain boundaries.<br/> 350 By 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/> 351 So you could let this namelist empty. 352 382 By 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. So you could let this namelist empty. 353 383 @sa For more information about boundaries, see @ref boundary 354 384 … … 365 395 time step). Or you could start from "partial" information about ocean state (Temperature and Salinity for example). 366 396 367 S irenallows you to create both of those initial state.<br/>397 SIREN allows you to create both of those initial state.<br/> 368 398 To create the initial state, you have to run:<br/> 369 399 ~~~~~~~~~~~~~~~~~~ … … 372 402 373 403 Here after is an example of namelist for *create_restart.exe*.<br/> 374 In this example, you create an initial state split on 81 "processors", and named restar _out.nc.<br/>404 In this example, you create an initial state split on 81 "processors", and named restart_out.nc.<br/> 375 405 The initial state is composed of temperature and salinity refined from an extraction of GLORYS fields. 376 406 ~~~~~~~~~~~~~~~~~~ … … 380 410 &namcfg 381 411 cn_varcfg = "PATH/NEMOGCM/TOOLS/SIREN/cfg/variable.cfg" 412 cn_dimcfg = "PATH/NEMOGCM/TOOLS/SIREN/cfg/dimension.cfg" 382 413 / 383 414 … … 479 510 &namcfg 480 511 cn_varcfg = "PATH/NEMOGCM/TOOLS/SIREN/cfg/variable.cfg" 512 cn_dimcfg = "PATH/NEMOGCM/TOOLS/SIREN/cfg/dimension.cfg" 481 513 / 482 514
Note: See TracChangeset
for help on using the changeset viewer.