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.
Changeset 13369 for utils/tools/SIREN/src/docsrc/2_quickstart.md – NEMO

Ignore:
Timestamp:
2020-07-31T10:50:52+02:00 (4 years ago)
Author:
jpaul
Message:

update: cf changelog inside documentation

File:
1 edited

Legend:

Unmodified
Added
Removed
  • utils/tools/SIREN/src/docsrc/2_quickstart.md

    r12080 r13369  
    44 
    55SIREN 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/> 
    77Actually SIREN creates all the input files you need to run a NEMO regional configuration.<br/> 
    8   
     8 
    99SIREN is composed of a set of Fortran programs : 
    1010<ul> 
     
    1212 <li>create_bathy.f90 to create regional grid bathymetry.</li> 
    1313 <li>merge_bathy.f90 to merge regional grid bathymetry with wider grid bathymetry 
    14  at boundaries.  
     14 at boundaries. 
    1515 @note the goal of this step is to avoid break in Bathymetry. 
    1616 This break may cause inconsistency between forcing fields  at boundary and regional fields. 
     
    5454Here after is an example of namelist for *create_coord.exe*.<br/> 
    5555In 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*.  
     56This new coordinates file is refined from an extraction of *coordinates_ORCA025.nc*. 
    5757~~~~~~~~~~~ 
    5858&namlog 
     
    135135The **namvar** sub-namelist lists variables to be used.<br/> 
    136136By default all the variables of the coarse/source coordinates file are used to create 
    137 the new coordinates file.<br/>  
     137the new coordinates file.<br/> 
    138138The interpolation methods to be used are defined in the configuration variables file (see 
    139139above). So you do not need to fill this sub-namelist too. 
     
    143143 
    144144<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> 
    146146 
    147147~~~~~~~~~~~ 
     
    158158~~~~~~~~~~~ 
    159159&namnst 
    160    rn_lonmin0 = -97.9  
    161    rn_lonmax0 = -62.3  
     160   rn_lonmin0 = -97.9 
     161   rn_lonmax0 = -62.3 
    162162   rn_latmin0 =   7.7 
    163163   rn_latmax0 =  30.8 
     
    187187 
    188188~~~~~~~~~~~ 
    189 &namnst           
    190    in_imin0 = 1402  
     189&namnst 
     190   in_imin0 = 1402 
    191191   in_imax0 = 62 
    192    in_jmin0 = 490  
    193    in_jmax0 = 570  
     192   in_jmin0 = 490 
     193   in_jmax0 = 570 
    194194 
    195195   in_rhoi = 5 
    196    in_rhoj = 5  
    197 /                 
     196   in_rhoj = 5 
     197/ 
    198198~~~~~~~~~~~ 
    199199@image html grid_glob_over_30.png 
     
    273273 
    274274&namout 
    275    cn_fileout = "PATH/bathy_fine.nc"       
     275   cn_fileout = "PATH/bathy_fine.nc" 
    276276/ 
    277277~~~~~~~~~~~~~~~~~~ 
     
    294294coordinates file.<br/> 
    295295@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  
     296periodicity of the fine grid. Indeed, if this variable is not inform, SIREN tries to read it 
    297297in the global attributes of the file. So if you created the fine coordinates with SIREN, you do not have to 
    298298fill it. In other case, you should add it to the namelist. 
     
    304304      <dd> defines the variable name ("Bathymetry" here) and the input file associated with. 
    305305            @warning The domain of the input Bathymetry have to be larger than the output domain. 
    306          @note  
     306         @note 
    307307         <ul> 
    308308            <li>if the input file is at coarse grid resolution (same than *cn_coord0*), the ouptut Bathymetry will be refined on fine grid.</li> 
     
    329329Finally, this **namout** sub-namelist defines the output file.<br/> 
    330330 
    331 @note All the output files create by SIREN include information about  
     331@note All the output files create by SIREN include information about 
    332332source file, indices, refinment and interpolation method used. 
    333333 
     
    375375 
    376376&namout 
    377    cn_fileout = "PATH/bathy_merged.nc"       
     377   cn_fileout = "PATH/bathy_merged.nc" 
    378378/ 
    379379~~~~~~~~~~~~~~~~~~ 
     
    421421It uses coordinates file *coord_fine.nc* to define horizontal grid. 
    422422and defines z-coordinate with partial steps. 
    423 The minimum depth of the final Bathymetry is 10m.  
     423The minimum depth of the final Bathymetry is 10m. 
    424424~~~~~~~~~~~ 
    425425&namlog 
     
    494494The **namsrc** sub-namelist defines the Bathymetry to be used. 
    495495Mainly SIREN need Bathymetry to create meshmask. 
    496 Here we also read coordinates directly on a file.  
    497 @note  
     496Here we also read coordinates directly on a file. 
     497@note 
    498498 1. here again you could add the *in_perio* parameter if need be i.e. if your 
    499499Bathymetry was not created by SIREN. 
     
    641641 
    642642&namout 
    643    cn_fileout = "PATH/restart_out.nc"       
     643   cn_fileout = "PATH/restart_out.nc" 
    644644   in_nproc = 81 
    645645/ 
     
    648648 
    649649## namlog, namcfg 
    650 As previously, we have the **namlog** and **namcfg** sub-namelists, as well as  
     650As previously, we have the **namlog** and **namcfg** sub-namelists, as well as 
    651651 
    652652## namsrc 
     
    755755 
    756756&namout 
    757    cn_fileout = "PATH/boundary_out.nc"       
     757   cn_fileout = "PATH/boundary_out.nc" 
    758758/ 
    759759~~~~~~~~~~~~~~~~~~ 
     
    762762 
    763763## namlog, namcfg 
    764 As previously, we have the **namlog** and **namcfg** sub-namelists, as well as  
     764As previously, we have the **namlog** and **namcfg** sub-namelists, as well as 
    765765 
    766766## namsrc 
Note: See TracChangeset for help on using the changeset viewer.