Changeset 13369 for utils/tools/SIREN/src/docsrc/2_quickstart.md
- Timestamp:
- 2020-07-31T10:50:52+02:00 (4 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
utils/tools/SIREN/src/docsrc/2_quickstart.md
r12080 r13369 4 4 5 5 SIREN is a software to set up regional configuration with 6 [NEMO](http://www.nemo-ocean.eu).<br/> 6 [NEMO](http://www.nemo-ocean.eu).<br/> 7 7 Actually SIREN creates all the input files you need to run a NEMO regional configuration.<br/> 8 8 9 9 SIREN is composed of a set of Fortran programs : 10 10 <ul> … … 12 12 <li>create_bathy.f90 to create regional grid bathymetry.</li> 13 13 <li>merge_bathy.f90 to merge regional grid bathymetry with wider grid bathymetry 14 at boundaries. 14 at boundaries. 15 15 @note the goal of this step is to avoid break in Bathymetry. 16 16 This break may cause inconsistency between forcing fields at boundary and regional fields. … … 54 54 Here after is an example of namelist for *create_coord.exe*.<br/> 55 55 In this example, you create a coordinates file named *coord_fine.nc*.<br/> 56 This new coordinates file is refined from an extraction of *coordinates_ORCA025.nc*. 56 This new coordinates file is refined from an extraction of *coordinates_ORCA025.nc*. 57 57 ~~~~~~~~~~~ 58 58 &namlog … … 135 135 The **namvar** sub-namelist lists variables to be used.<br/> 136 136 By default all the variables of the coarse/source coordinates file are used to create 137 the new coordinates file.<br/> 137 the new coordinates file.<br/> 138 138 The interpolation methods to be used are defined in the configuration variables file (see 139 139 above). So you do not need to fill this sub-namelist too. … … 143 143 144 144 <ul> 145 <li> you could define sub domain with coarse grid indices</li> 145 <li> you could define sub domain with coarse grid indices</li> 146 146 147 147 ~~~~~~~~~~~ … … 158 158 ~~~~~~~~~~~ 159 159 &namnst 160 rn_lonmin0 = -97.9 161 rn_lonmax0 = -62.3 160 rn_lonmin0 = -97.9 161 rn_lonmax0 = -62.3 162 162 rn_latmin0 = 7.7 163 163 rn_latmax0 = 30.8 … … 187 187 188 188 ~~~~~~~~~~~ 189 &namnst 190 in_imin0 = 1402 189 &namnst 190 in_imin0 = 1402 191 191 in_imax0 = 62 192 in_jmin0 = 490 193 in_jmax0 = 570 192 in_jmin0 = 490 193 in_jmax0 = 570 194 194 195 195 in_rhoi = 5 196 in_rhoj = 5 197 / 196 in_rhoj = 5 197 / 198 198 ~~~~~~~~~~~ 199 199 @image html grid_glob_over_30.png … … 273 273 274 274 &namout 275 cn_fileout = "PATH/bathy_fine.nc" 275 cn_fileout = "PATH/bathy_fine.nc" 276 276 / 277 277 ~~~~~~~~~~~~~~~~~~ … … 294 294 coordinates file.<br/> 295 295 @note in this namelist example, there is no need to set the variable *in_perio1* to define the NEMO 296 periodicity of the fine grid. Indeed, if this variable is not inform, SIREN tries to read it 296 periodicity of the fine grid. Indeed, if this variable is not inform, SIREN tries to read it 297 297 in the global attributes of the file. So if you created the fine coordinates with SIREN, you do not have to 298 298 fill it. In other case, you should add it to the namelist. … … 304 304 <dd> defines the variable name ("Bathymetry" here) and the input file associated with. 305 305 @warning The domain of the input Bathymetry have to be larger than the output domain. 306 @note 306 @note 307 307 <ul> 308 308 <li>if the input file is at coarse grid resolution (same than *cn_coord0*), the ouptut Bathymetry will be refined on fine grid.</li> … … 329 329 Finally, this **namout** sub-namelist defines the output file.<br/> 330 330 331 @note All the output files create by SIREN include information about 331 @note All the output files create by SIREN include information about 332 332 source file, indices, refinment and interpolation method used. 333 333 … … 375 375 376 376 &namout 377 cn_fileout = "PATH/bathy_merged.nc" 377 cn_fileout = "PATH/bathy_merged.nc" 378 378 / 379 379 ~~~~~~~~~~~~~~~~~~ … … 421 421 It uses coordinates file *coord_fine.nc* to define horizontal grid. 422 422 and defines z-coordinate with partial steps. 423 The minimum depth of the final Bathymetry is 10m. 423 The minimum depth of the final Bathymetry is 10m. 424 424 ~~~~~~~~~~~ 425 425 &namlog … … 494 494 The **namsrc** sub-namelist defines the Bathymetry to be used. 495 495 Mainly SIREN need Bathymetry to create meshmask. 496 Here we also read coordinates directly on a file. 497 @note 496 Here we also read coordinates directly on a file. 497 @note 498 498 1. here again you could add the *in_perio* parameter if need be i.e. if your 499 499 Bathymetry was not created by SIREN. … … 641 641 642 642 &namout 643 cn_fileout = "PATH/restart_out.nc" 643 cn_fileout = "PATH/restart_out.nc" 644 644 in_nproc = 81 645 645 / … … 648 648 649 649 ## namlog, namcfg 650 As previously, we have the **namlog** and **namcfg** sub-namelists, as well as 650 As previously, we have the **namlog** and **namcfg** sub-namelists, as well as 651 651 652 652 ## namsrc … … 755 755 756 756 &namout 757 cn_fileout = "PATH/boundary_out.nc" 757 cn_fileout = "PATH/boundary_out.nc" 758 758 / 759 759 ~~~~~~~~~~~~~~~~~~ … … 762 762 763 763 ## namlog, namcfg 764 As previously, we have the **namlog** and **namcfg** sub-namelists, as well as 764 As previously, we have the **namlog** and **namcfg** sub-namelists, as well as 765 765 766 766 ## namsrc
Note: See TracChangeset
for help on using the changeset viewer.