User Configuration File - Preprocessing Sections¶
To execute the SURF-NEMO package, users need to configure various model parameters that define several aspects of the simulation, including the specific simulation region, simulation period, horizontal and vertical turbulence schemes, input datasets, interpolation methods, etc. These parameters are essential for the pre- and post-processing stages, as well as for generating the Fortran namelist required to execute the NEMO-OCE model.
The configuration process requires specifying the values of these parameters in the user configuration file, setParFree.json. This file is structured to organize all user-configurable input parameters into sections based on their respective functions.
It has been designed to meet the needs of intermediate-level users, particularly PhD researchers, who are conducting downscaling experiments and validating specific aspects of the NEMO model.
Certain model parameters are predefined and fixed within the SURF source package. These fixed parameters are specified in the setParFix.ncl file. For more information about these fixed parameters, please refer to Appendix A.
In this chapter, we provide detailed explanations for each section of the user configuration file, including the acceptable parameter values, unit measurements, and the “reference value” used in the test case experiment (see Section 3.3).
Configuration file and JSON Object Structure¶
The user configuration file for the SURF-NEMO package is based on the JavaScript Object Notation (JSON) format, a simple, text-based method for storing and transmitting structured data. JSON is both "self-describing" and easy to read, making it an ideal choice for configuration files. It supports complex data types and structures and is widely used in web applications for its simplicity and flexibility.
JSON syntax is derived from JavaScript object notation and can represent data in two main forms: arrays and objects (associative arrays of name/value pairs, also referred to as properties). An array is a comma-separated list of values enclosed in square brackets [ ], while an object is a collection of name/value pairs enclosed in curly brackets { }. Each name/value pair consists of a field name (in double quotes) followed by a colon :, and then the field value. The value can be of various types, including numbers (integer or floating-point), strings (enclosed in double quotes), booleans (true or false), arrays, objects, or null.
In the SURF-NEMO package's configuration file, the top-level structure is the "sections" array, which contains a collection of objects. Each object represents a configuration section and includes three key properties:
- Title – A description of the section's contents.
- ID – A unique four-digit alphanumeric identifier (e.g.,
id = A001,A002for pre-processing sections, andB001,B002for post-processing sections). - Items – An array of parameters specific to that section.
Each element of the "items" array is an object that consists of:
- Name – The name of the parameter.
- Value – The corresponding value for the parameter.
- Data type – The type of the parameter value (e.g.,
int,float,double,bool,string). - Description – A brief explanation of what the parameter represents.
Figure 5.1 illustrates the structure of the JSON configuration file for the current version of the SURF-NEMO package. This organized format allows users to efficiently manage and customize their simulation parameters.
General Configuration and Initialization¶
set_surf¶
This section contains the following two parameters:
| Parameter | Value | Type | Description |
|---|---|---|---|
nnest |
1 | int | number of nesting domain |
nameNestDomain |
gulfTaranto | string | name of the nest domain to simulate |
set_lrun¶
This section includes logical parameters that control the activation or deactivation of specific tasks within the simulation. It determines which processes are enabled during the model's run.
| Parameter | Value | Type | Description |
|---|---|---|---|
lrun_meshmask |
True | bool | enables the execution of the MESHMASK GENERATION phase |
lrun_regridPre |
True | bool | enables the execution of the DATA-REGRIDDING phase |
lrun_regridPreWeights |
True | bool | enables the computation/copy of WEIGHT-FILEs for input_fields REMAPPING (if lrun_regridPre=True) |
lrun_ocean |
True | bool | enables the execution of the NEMO code |
lrun_regridOutUV |
False | bool | enables the execution of the output-UV_fields REMAPPING (from UV GRID to T-GRID) |
lrun_regridOutUVWeghts |
False | bool | enables the computation/copy of WEIGHT-FILEs for output-UV_fields REMAPPING (if lrun_regridOutUV=True) |
lrun_shapFiltBat |
True | bool | enables the execution of the SHAPIRO Filter for Bathymetric datasets |
lrun_shapFiltOce |
False | bool | enables the execution of the SHAPIRO Filter for Ocean datasets |
set_nemoCPPkey¶
This section contains the compilation keys used to compile the NEMO code.
| Parameter | Value | Type | Description |
|---|---|---|---|
cppkey_zdf |
key_zdfric | string | name of CPP-keys for Vertical viscosity/diffusivity to check NEMO compilation: key_zdfric,key_zdftke (if =NOTUSED, cppkey not used) |
cppkey_spg |
key_dynspg_ts | string | name of CPP-keys for Surface Pressure Gradient to check NEMO compilation: key_dynspg_exp, key_dynspg_flt, key_dynspg_ts (if =NOTUSED, cppkey not used) |
cppkey_obc |
key_bdy | string | name of CPP-keys for Open Boundary Conditions to check NEMO compilation: key_bdy (if =NOTUSED, cppkey not used) |
cppkey_tide |
NOTUSED | string | name of CPP-keys for Tidal Potential forcing to check NEMO compilation: key_tide (if =NOTUSED, cppkey not used) |
cppkey_hpc |
key_mpp_mpi | string | name of CPP-keys for Massively Parallel Processing to check NEMO compilation: key_mpp_mpi (if =NOTUSED, cppkey not used) |
cppkey_dia |
NOTUSED | string | name of CPP-keys for Instantaneous output to check NEMO compilation: key_diainstant (if =NOTUSED, cppkey not used) |
cppkey_signfunc |
key_nosignedzero | string | name of CPP-keys to deal with intrinsic SIGN function (fortran compiler) to check NEMO compilation: key_nosignedzero (if =NOTUSED, cppkey not used) |
Spatial Grid Generation Settings¶
set_xyGrid¶
This section defines the input parameters required for generating the horizontal grid of the model. The horizontal grid setup determines the spatial resolution and the domain layout of the simulation area.
| Parameter | Value | Type | Description |
|---|---|---|---|
gr_xygridSpec |
0 | int | parameters specification for the horizontal grid: (=0)z(nx,ny,x0,y0,dxy) (=1)z(x0,y0,x1,y1,dxy) |
gr_jpidta |
94 | int | number of grid points in zonal direction to specify if xygridSpec=0 (if =NOTUSED, parameter not read) |
gr_jpjdta |
79 | int | number of grid points in meridional direction to specify if xygridSpec=0 (if =NOTUSED, parameter not read) |
gr_ppglam0 |
16.4375 | float | longitude of the first raw and column T-point to specify if xygridSpec=0,1 |
gr_ppglam1 |
NOTUSED | float | longitude of the last raw and column T-point to specify if xygridSpec=1 (if =NOTUSED, parameter not read) |
gr_ppgphi0 |
38.9375 | float | latitude of the first raw and column T-point to specify if xygridSpec=0,1 |
gr_ppgphi1 |
NOTUSED | float | latitude of the last raw and column T-point to specify if xygridSpec=1 (if =NOTUSED, parameter not read) |
gr_jp_cfg |
48. | float | child model resolution (1/gr_jp_cfg) to specify if xygridSpec=0,1 |
gr_jp_cfg_father |
16. | float | father model resolution (1/gr_jp_cfg_father) |
set_zGrid¶
This section includes the input parameters used to generate the vertical grid. The vertical grid is essential for defining the stratification and depth levels of the model, impacting the vertical resolution of the simulation.
| Parameter | Value | Type | Description |
|---|---|---|---|
gr_jpkdta |
120 | int | number of vertical levels |
zgrid_spec |
1 | int | parameters specification for the vertical grid: (=0)z(h0,h1,hsur,hcr,hth) (=1)z(dzmin,hmax,hcr,hth) |
gr_ppsur |
NOTUSED | double | parameter h_sur for the z-coord. transformation to specify if zgrid_spec=0 (if =NOTUSED, parameter not read) |
gr_ppa0 |
NOTUSED | double | parameter h_0 for the z-coordinate transformation to specify if zgrid_spec=0 (if =NOTUSED, parameter not read) |
gr_ppa1 |
NOTUSED | double | parameter h_1 for the z-coordinate transformation to specify if zgrid_spec=0 (if =NOTUSED, parameter not read) |
gr_ppkth |
100.0 | double | parameter h_th which gives the approximate layer number above which stretching will be maximum (usually of order nz/2) |
gr_ppacr |
30.0 | double | parameter h_cr which gives the grid stretching factor (the higher gr_ppacr, the smaller the stretching) |
gr_ppdzminw |
2.8 | double | depth of the top (first) model layer depth of second 'w' level to specify if zgrid_spec=1 (if =NOTUSED, parameter not read) |
gr_pphmaxw |
2900.0 | double | maximum depth of the ocean depth of the last 'w' level (set to 0.0 to be computed) to specify if zgrid_spec=1 |
gr_dbletanh |
False | bool | enables the use of the double tanh function for vertical coordinates |
gr_ppa2 |
NOTUSED | double | parameter h_2 to specify if gr_dbletanh=True (if =NOTUSED, parameter not read) |
gr_ppkth2 |
NOTUSED | double | parameter h_th2 if gr_dbletanh=True (if =NOTUSED, parameter not read) |
gr_ppacr2 |
NOTUSED | double | parameter h_cr2 if gr_dbletanh=True (if =NOTUSED, parameter not read) |
Simulation Timing Settings¶
set_dateTime¶
This section specifies the parameters that define the simulation period and time discretization. It includes the start and end dates of the simulation, as well as the time steps for model calculations.
| Parameter | Value | Type | Description |
|---|---|---|---|
start_date |
20141005 | string | initial date of the simulation (the run starts at 00:00) |
ndays |
3 | int | total number of simulation days |
ndays_spinup |
1 | int | number of spin-up days |
dom_rdt |
150. | float | simulation 'baroclinic' time step (...40,48,50,60,72,80,90,100,120,144...) |
runMan_write |
24 | int | frequency of write in the output file expressed as the number of simulation time steps |
dom_btAuto |
False | bool | enables the automatic definition of baro-timestep to be just below a user-defined maximum Courant number dom_btCmax |
dom_btCmax |
0.8 | float | maximum Courant number (allowed if dom_btAuto=True) |
dom_baro |
100 | int | number of iterations of barotropic mode during dom_rdt (allowed if dom_btAuto=False) |
runMan_rstart |
True | bool | start from rest (False) or from a restart file (True) |
ndays_xsimu |
1.0 | float | number of days per each restart simulation |
Boundary and Surface Condition Settings¶
set_sbc¶
This section contains the parameters used to set up surface boundary conditions.
| Parameter | Value | Type | Description |
|---|---|---|---|
sbc_iformulat |
0 | int | surface boundary condition formulation to be used (=0)MFS bulk formulat,(=1)fluxform+ssRest,(=2)CORE formulation |
sbc_ltimeInterp |
True | bool | activate, or not, the time interpolation (=False) steplike shape forcing (=True) broken line shape forcing |
sbc_aprdyn |
False | bool | enables the inclusion of atmospheric pressure gradient in ocean and ice Eqs. |
sbc_sclapr |
1. | float | scaling factor to convert atmospheric pressure from hPa to Pa |
set_obc¶
This section provides the parameters for defining lateral open boundary conditions.
| Parameter | Value | Type | Description |
|---|---|---|---|
obc_dyn2d |
flather | string | algorithm of boundary condition for barotropic solution: flather |
obc_dyn2d_dta |
1 | int | boundary data to use: (=0)Initial condition (=1)external data (=2)tidal forcing (=3)external data+tidal |
obc_dyn3d |
frs | string | algorithm of boundary condition for baroclinic velocities: frs, orlanski |
obc_dyn3d_dta |
1 | int | boundary data to use: (=0)Initial condition (=1)external data |
obc_tra |
frs | string | algorithm of boundary condition for active tracers: frs, orlanski |
obc_tra_dta |
1 | int | boundary data to use: (=0)Initial condition (=1)external data |
obc_rimwidth |
1 | int | width of the FRS zone |
obc_ltimeInterp |
True | bool | activate, or not, the time interpolation (=False) steplike shape forcing (=True) broken line shape forcing |
obc_lvelCorr |
True | bool | activate the Integral Constraint method to preserve the total transport after the interpolation |
set_tide¶
This section includes the parameters for configuring tidal components in the model. It allows for the inclusion of tidal effects either as the equilibrium tidal sea level and/or only at the lateral boundaries.
| Parameter | Value | Type | Description |
|---|---|---|---|
tide_ltidePot |
False | bool | enables the use of tidal potential forcing |
tide_clname01 |
K1 | string | name of the 1-st tidal component (if =NOTUSED, component not used) |
tide_clname02 |
O1 | string | name of the 2-st tidal component (if =NOTUSED, component not used) |
tide_clname03 |
P1 | string | name of the 3-st tidal component (if =NOTUSED, component not used) |
tide_clname04 |
Q1 | string | name of the 4-st tidal component (if =NOTUSED, component not used) |
tide_clname05 |
K2 | string | name of the 5-st tidal component (if =NOTUSED, component not used) |
tide_clname06 |
M2 | string | name of the 6-st tidal component (if =NOTUSED, component not used) |
tide_clname07 |
N2 | string | name of the 7-st tidal component (if =NOTUSED, component not used) |
tide_clname08 |
S2 | string | name of the 8-st tidal component (if =NOTUSED, component not used) |
tide_clname09 |
M4 | string | name of the 9-st tidal component (if =NOTUSED, component not used) |
tide_clname10 |
Mm | string | name of the 10-st tidal component (if =NOTUSED, component not used) |
tide_clname11 |
Mf | string | name of the 11-st tidal component (if =NOTUSED, component not used) |
tide_clname12 |
NOTUSED | string | name of the 12-st tidal component (if =NOTUSED, component not used) |
tide_clname13 |
NOTUSED | string | name of the 13-st tidal component (if =NOTUSED, component not used) |
tide_clname14 |
NOTUSED | string | name of the 14-st tidal component (if =NOTUSED, component not used) |
tide_clname15 |
NOTUSED | string | name of the 15-st tidal component (if =NOTUSED, component not used) |
tide_clname16 |
NOTUSED | string | name of the 16-st tidal component (if =NOTUSED, component not used) |
Physical Parameterization Settings¶
set_eos¶
This section defines the parameters related to the equation of state of seawater.
| Parameter | Value | Type | Description |
|---|---|---|---|
eos_type |
0 | int | type of equation of state and Brunt-Vaisala frequency: (=-1)TEOS-10, (=0)EOS-80, (=1)S-EOS |
eos_useCT |
False | bool | enables the use of Conservative Temp. ==> surface CT converted in Pot. Temp. in sbcssm |
eos_a0 |
0.1655 | float | S-EOS coefficients: thermal expansion coefficient |
eos_b0 |
0.76554 | float | S-EOS coefficients: saline expansion coefficient |
eos_lambda1 |
0.05952 | float | S-EOS coefficients: cabbeling coefficient in T^2 (=0 for linear eos) |
eos_lambda2 |
0.00074914 | float | S-EOS coefficients: cabbeling coefficient in S^2 (=0 for linear eos) |
eos_mu1 |
0.0001497 | float | S-EOS coefficients: thermobaric coefficient in T (=0 for linear eos) |
eos_mu2 |
1.109e-05 | float | S-EOS coefficients: thermobaric coefficient in S (=0 for linear eos) |
eos_nu |
0.0024341 | float | S-EOS coefficients: cabbeling coefficient in T*S (=0 for linear eos) |
set_botFric¶
This section contains the parameters used to specify bottom friction settings
| Parameter | Value | Type | Description |
|---|---|---|---|
botB_bfri2 |
1.e-3 | float | bottom drag coefficient (non-linear case) |
botB_bfeb2 |
2.5e-3 | float | bottom turbulent kinetic energy background (m²/s²) |
set_xyturbTracers¶
This section includes the free input parameters for the parameterization of lateral subgrid-scale diffusion for tracers like temperature and salinity.
| Parameter | Value | Type | Description |
|---|---|---|---|
tra_typeOperator |
1 | int | type of the operator used (0)laplacian, (1)bilaplacian |
tra_eddycoeffSpec |
1 | int | horizontal eddy coefficient specification (0)defined by coeff. tra_eddycoeff_child, (1)defined from coeff. tra_eddycoeff_father according to fat/child relation |
tra_eddycoeff_child |
-6.e8 | float | horizontal eddy diffusivity (>0 (m²/s) laplacian or <0 (m⁴/s²) bilaplacian) of the child model (if =NOTUSED, parameter not read) |
tra_eddycoeff_father |
-6.e8 | float | horizontal eddy diffusivity (>0 (m²/s) laplacian or <0 (m⁴/s²) bilaplacian) of the father model for fat/child coefficient relation (if =NOTUSED, parameter not read) |
tra_factor |
1. | float | factor used in fat/child coefficient relation (if laplacian: (a_child=factor*???), if bilaplacian: (a_child=factor*a_fat(Dx_child/Dx_fat)^4)) |
set_xyturbMomentum¶
This section includes the free input parameters that define the parameterization of lateral subgrid-scale viscosity for momentum.
| Parameter | Value | Type | Description |
|---|---|---|---|
dyn_typeOperator |
1 | int | type of the operator used (0)laplacian, (1)bilaplacian |
dyn_eddycoeffSpec |
1 | int | horizontal eddy coefficient specification (0)defined by coeff. dyn_eddycoeff_child, (1)defined from coeff. dyn_eddycoeff_father according to fat/child relation |
dyn_eddycoeff_child |
-0.5e9 | float | horizontal eddy viscosity (>0 (m²/s) laplacian or <0 (m⁴/s²) bilaplacian) of the child model (if =NOTUSED, parameter not read) |
dyn_eddycoeff_father |
-1.e9 | float | horizontal eddy viscosity (>0 (m²/s) laplacian or <0 (m⁴/s²) bilaplacian) of the father model for fat/child coefficient relation (if =NOTUSED, parameter not read) |
dyn_factor |
1. | float | factor used in father/child coefficient relation (if laplacian: (a_child=factor*???), if bilaplacian: (a_child=factor*a_fat(Dx_child/Dx_fat)^4)) |
set_zturb¶
This section specifies the parameters for vertical turbulence, including eddy viscosity and diffusivity coefficients, which are essential for modeling vertical mixing and stratification in the water column.
| Parameter | Value | Type | Description |
|---|---|---|---|
zdyn_avm0 |
1.2e-5 | float | vertical eddy viscosity [m²/s] (background Kz if not 'key_zdfcst') |
zdyn_avt0 |
1.2e-6 | float | vertical eddy diffusivity [m²/s] (background Kz if not 'key_zdfcst') |
zdyn_avevd |
10. | float | evd mixing coefficient [m²/s] |
zdynric_avmri |
1.e-2 | float | maximum value of the vertical viscosity |
zdynric_alp |
5. | float | ... |
zdynric_ric |
2 | int | ... |
zdynric_ekmfc |
0.7 | float | ... |
zdynric_mldmin |
1.0 | float | ... |
zdynric_mldmax |
1000.0 | float | ... |
zdynric_wtmix |
10.0 | float | ... |
zdynric_wvmix |
10.0 | float | ... |
zdynric_mldw |
False | bool | ... |
zdyntke_ediff |
0.1 | float | ... |
zdyntke_ediss |
0.7 | float | ... |
zdyntke_ebb |
67.83 | float | ... |
zdyntke_emin |
1.e-6 | float | ... |
zdyntke_emin0 |
1.e-4 | float | ... |
zdyntke_mxl |
2 | int | ... |
zdyntke_pdl |
1 | int | ... |
zdyntke_lmxl0 |
True | bool | ... |
zdyntke_rmxl0 |
0.04 | float | ... |
zdyntke_llc |
True | bool | ... |
zdyntke_rlc |
0.15 | float | ... |
zdyntke_etau |
0 | int | ... |
zdyntke_efr |
0.05 | float | ... |
zdyntke_htau |
1 | int | ... |
zdyngls_emin |
1.e-6 | float | ... |
zdyngls_epsmin |
1.e-12 | float | ... |
zdyngls_length_lim |
True | bool | ... |
zdyngls_clim_galp |
0.53 | float | ... |
zdyngls_sigpsi |
True | bool | ... |
zdyngls_rcrban |
100. | float | ... |
zdyngls_charn |
70000. | float | ... |
zdyngls_hsro |
0.02 | float | ... |
zdyngls_frac_hs |
1.3 | float | ... |
zdyngls_z0_met |
2 | int | ... |
zdyngls_bc_surf |
1 | int | ... |
zdyngls_bc_bot |
1 | int | ... |
zdyngls_stab_func |
2 | int | ... |
zdyngls_clos |
1 | int | ... |
zdynkpp_kpprimix |
True | bool | ... |
zdynkpp_difmiw |
1.0e-04 | float | ... |
zdynkpp_difsiw |
0.1e-04 | float | ... |
zdynkpp_riinfty |
0.8 | float | ... |
zdynkpp_difri |
0.0050 | float | ... |
zdynkpp_bvsqcon |
-0.01e-07 | float | ... |
zdynkpp_difcon |
1. | float | ... |
zdynkpp_avb_k |
0 | int | ... |
zdynkpp_ave |
1 | int | ... |
Dataset Download Configuration¶
set_dataDownlCoast_urlName¶
This section defines the parameters used to construct the URL for accessing input coastline datasets. These datasets can be sourced from either a local directory or a remote repository.
| Parameter | Value | Type | Description |
|---|---|---|---|
urlCoast_usr |
gofs | string | username to access the datasets from a remote FTP server |
urlCoast_pwd |
L##OOkkl!as | string | password to access the datasets from a remote FTP server |
urlCoast_urlbase |
file:///scratch/surf/surf_datasets/ current/coastline/GSHHS_shp/(RESCOAST) | string | parametric URL name (i.e. ftp:/... or file:///...) for the coastline datasets. Parameters: (RESOL) |
urlCoast_resol |
h | string | name for spatial resolution used to replace the substring (RESCOAST) on the parametric URL name (if =NOTUSED, parameter not read) |
set_dataDownlCoast_fileName¶
This section specifies the parameters required to generate the filenames of the input coastline datasets. These filenames help identify the relevant files in the storage location.
| Parameter | Value | Type | Description |
|---|---|---|---|
fileCoast_lland |
True | bool | enables the use of the land coastline |
fileCoast_filebaseLand |
GSHHS_(RESCOAST)_L1.shp | string | files name for NOAA coastline datasets contains boundary between land and ocean (if fileCoast_lland=True). Parameters: (RESCOAST) |
fileCoast_llake |
False | bool | enables the use of the lake coastline |
fileCoast_filebaseLake |
GSHHS_(RESCOAST)_L2.shp | string | files name for NOAA coastline datasets contains boundary between lake and land (if fileCoast_llake=True). Parameters: (RESCOAST) |
fileCoast_lislandlake |
False | bool | enables the use of the isle-in-lake coastline |
fileCoast_filebaseIslandlake |
GSHHS_(RESCOAST)_L3.shp | string | files name for NOAA coastline datasets contains boundary between island-in-lake and lake (if fileCoast_lislandlake=True). Parameters: (RESCOAST) |
fileCoast_resol |
h | string | name for spatial resolution used to replace the substring (RESCOAST) on the parametric file name (if =NOTUSED, parameter not read) |
fileCoast_lcompression |
False | bool | enables if datasets you want to download are gzip compressed files (*.gz) |
fileCoast_lkeepSrcFull |
True | bool | enables if you want to keep the downloaded uncut datasets |
set_dataDownlBat_urlName¶
This section defines the parameters used to construct the URL for accessing input bathymetry datasets. These datasets can be sourced from either a local directory or a remote repository.
| Parameter | Value | Type | Description |
|---|---|---|---|
urlBat_usr |
gofs | string | username to access the datasets from a remote FTP server |
urlBat_pwd |
L##OOkkl!as | string | password to access the datasets from a remote FTP server |
urlBat_urlbase |
file:///scratch/surf/surf_datasets/ current/bathymetry | string | parametric URL name (i.e. ftp:/... or file:///...) for the bathymetric datasets. Parameters: (RESOL) |
urlBat_resol |
h | string | name for spatial resolution used to replace the substring (RESOL) on the parametric URL name (if =NOTUSED, parameter not read) |
set_dataDownlBat_fileName¶
This section specifies the parameters required to generate the filenames of the input bathymetry datasets. These filenames help identify the relevant files in the storage location.
| Parameter | Value | Type | Description |
|---|---|---|---|
fileBat_filebase |
macroMED_bathyGEBCO.nc | string | parametric file name for the source bathymetric datasets. Parameters: (RESBAT) |
fileBat_resol |
NOTUSED | string | name for spatial resolution used to replace the substring (RESBAT) on the parametric file name (if =NOTUSED, parameter not read) |
fileBat_lcompression |
False | bool | enables if datasets you want to download are gzip compressed files (*.gz) |
fileBat_llonFlip |
False | bool | (=True) if longitude coordinate is in the 0 to 360 range, (=True) if longitude is in -180:+180 range |
fileBat_llonCycl |
True | bool | Logical variable=True if you use global data and longitude is cyclic |
fileBat_llatInv |
False | bool | enables if the dataset contains latitude decreasing through the pole |
fileBat_lkeepSrcFull |
True | bool | enables if you want to keep the downloaded uncut datasets |
set_dataDownlBat_varName¶
This section outlines the parameters related to the variable names used within the input bathymetry datasets. These variable names are crucial for accurately extracting and utilizing the data within the files.
| Parameter | Value | Type | Description |
|---|---|---|---|
srcDimBat_lon |
lon | string | name of the dimension for the longitude |
srcDimBat_lat |
lat | string | name of the dimension for the latitude |
srcCrdBat_lon |
lon | string | name of the variable for longitude coordinate |
srcCrdBat_lat |
lat | string | name of the variable for latitude coordinate |
srcVarBat_elev |
elevation | string | name of the variable for the Sea Floor Elevation |
set_dataDownlAtmMesh_urlName¶
This section defines the parameters used to construct the URL for accessing atmospheric meshmask datasets. These datasets can be sourced from either a local directory or a remote repository.
| Parameter | Value | Type | Description |
|---|---|---|---|
urlAtmMesh_usr |
gofs | string | username to access the input datasets before the spinup-time from a remote FTP server |
urlAtmMesh_pwd |
L##OOkkl!as | string | password to access the input datasets before the spinup-time from a remote FTP server |
urlAtmMesh_urlbase |
file:///scratch/surf/indata_offline/ gulfTaranto_20141005/data/data00/ indata/atmosphere/srcFull | string | parametric URL name (i.e. ftp:/... or file:///...) for zonal air velocity datasets before the spinup-time. Parameters: (FIELD),YYYY(p)MM(p)DD(p) |
urlAtmMesh_velU |
v10m | string | name (for zonal air velocity) used to replace the substring (FIELD) on the parametric URL name |
urlAtmMesh_velV |
v10m | string | name (for meridional air velocity) used to replace the substring (FIELD) on the parametric URL name |
urlAtmMesh_mslp |
mslp | string | name (for mean sea-level pressure) used to replace the substring (FIELD) on the parametric URL name |
urlAtmMesh_cloudCov |
tcc | string | name (for total cloud cover) used to replace the substring (FIELD) on the parametric URL name |
urlAtmMesh_temp |
t2m | string | name (for air temperature) used to replace the substring (FIELD) on the parametric URL name |
urlAtmMesh_dpTemp |
d2m | string | name (for dewpoint temperature) used to replace the substring (FIELD) on the parametric URL name |
urlAtmMesh_prec |
precip | string | name (for total precipitation) used to replace the substring (FIELD) on the parametric URL name |
urlAtmMesh_tauU |
tauU | string | name (for zonal wind stress) used to replace the substring (FIELD) on the parametric URL name |
urlAtmMesh_tauV |
tauV | string | name (for meridional wind stress) used to replace the substring (FIELD) on the parametric URL name |
urlAtmMesh_qtot |
qtot | string | name (for total heat flux) used to replace the substring (FIELD) on the parametric URL name |
urlAtmMesh_qsr |
qsr | string | name (for solar Radiation Penetration) used to replace the substring (FIELD) on the parametric URL name |
urlAtmMesh_emp |
emp | string | name (for mass flux exchanged) used to replace the substring (FIELD) on the parametric URL name |
urlAtmMesh_tempS |
sst | string | name (for surface temperature) used to replace the substring (FIELD) on the parametric URL name |
urlAtmMesh_salS |
sss | string | name (for surface salinity) used to replace the substring (FIELD) on the parametric URL name |
urlAtmMesh_umid |
umid | string | name (for air humidity) used to replace the substring (FIELD) on the parametric URL name |
urlAtmMesh_radLW |
lwrd | string | name (for long wave radiation) used to replace the substring (FIELD) on the parametric URL name |
urlAtmMesh_radSW |
swrd | string | name (for short wave radiation) used to replace the substring (FIELD) on the parametric URL name |
urlAtmMesh_snow |
snow | string | name (for solid precipitation) used to replace the substring (FIELD) on the parametric URL name |
set_dataDownlAtmMesh_fileName¶
This section specifies the parameters required to generate the filenames of the atmospheric meshmask datasets. These filenames help identify the relevant files in the storage location.
| Parameter | Value | Type | Description |
|---|---|---|---|
fileAtmMesh_lcompression |
False | bool | enables if datasets you want to download are gzip compressed files (*.gz) |
fileAtmMesh_llonFlip |
False | bool | (=True) if longitude coord. is in the 0 to 360 range (=True) if longitude is in -180:+180 range |
fileAtmMesh_llonCycl |
True | bool | Logical variable=True if you use global data and longitude is cyclic |
fileAtmMesh_llatInv |
True | bool | enables if the dataset contains latitude decreasing through the pole |
fileAtmMesh_filebase_velU |
YYYY(i)MM(i)DD(i)-ECMWF---AM0125-MEDATL-bYYYY(i+1)MM(i+1)DD(i+1)_an-fv05.00.nc | string | parametric FILE name for the zonal air velocity datasets before the spinup-time (sbc_iformulat=0,2) |
fileAtmMesh_filebase_velV |
YYYY(i)MM(i)DD(i)-ECMWF---AM0125-MEDATL-bYYYY(i+1)MM(i+1)DD(i+1)_an-fv05.00.nc | string | parametric FILE name for the meridional air velocity datasets before the spinup-time (sbc_iformulat=0,2) |
fileAtmMesh_filebase_mslp |
YYYY(i)MM(i)DD(i)-ECMWF---AM0125-MEDATL-bYYYY(i+1)MM(i+1)DD(i+1)_an-fv05.00.nc | string | parametric FILE name for the Mean sea-level pressure datasets before the spinup-time (sbc_iformulat=0 or/and sbc_aprdyn) |
fileAtmMesh_filebase_cloudCov |
YYYY(i)MM(i)DD(i)-ECMWF---AM0125-MEDATL-bYYYY(i+1)MM(i+1)DD(i+1)_an-fv05.00.nc | string | parametric FILE name for the Total cloud cover datasets before the spinup-time (sbc_iformulat=0) |
fileAtmMesh_filebase_temp |
YYYY(i)MM(i)DD(i)-ECMWF---AM0125-MEDATL-bYYYY(i+1)MM(i+1)DD(i+1)_an-fv05.00.nc | string | parametric FILE name for the air temperature datasets before the spinup-time (sbc_iformulat=0,2) |
fileAtmMesh_filebase_dpTemp |
YYYY(i)MM(i)DD(i)-ECMWF---AM0125-MEDATL-bYYYY(i+1)MM(i+1)DD(i+1)_an-fv05.00.nc | string | parametric FILE name for the dewpoint temperature datasets before the spinup-time (sbc_iformulat=0) |
fileAtmMesh_filebase_prec |
YYYY(i)MM(i)DD(i)_YYYY(i+1)MM(i+1)DD(i+1)-ECMWF---AM025-MEDATL-bYYYY(i)MM(i)DD(i)_fc00-fv02.00_PREC.nc | string | parametric FILE name for the Total precipitation datasets before the spinup-time (sbc_iformulat=0,2) |
fileAtmMesh_filebase_tauU |
NOTUSED | string | parametric FILE name for the zonal Wind stress datasets before the spinup-time (sbc_iformulat=1) |
fileAtmMesh_filebase_tauV |
NOTUSED | string | parametric FILE name for the meridional Wind stress datasets before the spinup-time (sbc_iformulat=1) |
fileAtmMesh_filebase_qtot |
NOTUSED | string | parametric FILE name for the Total heat flux datasets before the spinup-time (sbc_iformulat=1) |
fileAtmMesh_filebase_qsr |
NOTUSED | string | parametric FILE name for the Solar Radiation Penetration datasets before the spinup-time (sbc_iformulat=1) |
fileAtmMesh_filebase_emp |
NOTUSED | string | parametric FILE name for the Mass flux exchanged datasets before the spinup-time (sbc_iformulat=1) |
fileAtmMesh_filebase_tempS |
NOTUSED | string | parametric FILE name for the Surface Temperature datasets before the spinup-time (sbc_iformulat=1) |
fileAtmMesh_filebase_salS |
NOTUSED | string | parametric FILE name for the Surface Salinity datasets before the spinup-time (sbc_iformulat=1) |
fileAtmMesh_filebase_umid |
NOTUSED | string | parametric FILE name for the Air Humidity datasets before the spinup-time (sbc_iformulat=1) |
fileAtmMesh_filebase_radLW |
NOTUSED | string | parametric FILE name for the Long Wave Radiation datasets before the spinup-time (sbc_iformulat=1) |
fileAtmMesh_filebase_radSW |
NOTUSED | string | parametric FILE name for the Short Wave Radiation datasets before the spinup-time (sbc_iformulat=1) |
fileAtmMesh_filebase_snow |
NOTUSED | string | parametric FILE name for the Solid precipitation datasets before the spinup-time (sbc_iformulat=1) |
fileAtmMesh_lkeepSrcFull |
True | bool | enables if you want to keep the downloaded uncut datasets |
| --- |
set_dataDownlAtmMesh_varName¶
This section outlines the parameters related to the variable names used within the atmospheric meshmask datasets. These variable names are crucial for accurately extracting and utilizing the data within the files.
| Parameter | Value | Type | Description |
|---|---|---|---|
srcDimAtmMesh_lon |
lon | string | name of the dimension for the longitude |
srcDimAtmMesh_lat |
lat | string | name of the dimension for the latitude |
srcDimAtmMesh_time |
time | string | name of the dimension for the time |
srcCrdAtmMesh_lon |
lon | string | name of the variable containing longitude coordinate |
srcCrdAtmMesh_lat |
lat | string | name of the variable containing latitude coordinate |
srcCrdAtmMesh_time |
time | string | name of the variable containing time coordinate |
srcVarAtmMesh_mask |
LSM | string | name of the variable containing the Land Sea Mask (if sbc_iformulat=0,2) |
srcVarAtmMesh_lont |
NOTUSED | string | name of the variable containing longitude coordinate (if sbc_iformulat=1) |
srcVarAtmMesh_lonu |
NOTUSED | string | name of the variable containing longitude coordinate (if sbc_iformulat=1) |
srcVarAtmMesh_lonv |
NOTUSED | string | name of the variable containing longitude coordinate (if sbc_iformulat=1) |
srcVarAtmMesh_latt |
NOTUSED | string | name of the variable containing latitude coordinate (if sbc_iformulat=1) |
srcVarAtmMesh_latu |
NOTUSED | string | name of the variable containing latitude coordinate (if sbc_iformulat=1) |
srcVarAtmMesh_latv |
NOTUSED | string | name of the variable containing latitude coordinate (if sbc_iformulat=1) |
srcVarAtmMesh_maskt |
NOTUSED | string | name of the variable containing the Land Sea Mask (if sbc_iformulat=1) |
srcVarAtmMesh_masku |
NOTUSED | string | name of the variable containing the Land Sea Mask (if sbc_iformulat=1) |
srcVarAtmMesh_maskv |
NOTUSED | string | name of the variable containing the Land Sea Mask (if sbc_iformulat=1) |
set_dataDownlAtm_urlName_preSpinup¶
This section contains the parameters needed to build the URL for accessing pre-spinup atmospheric fields datasets. The datasets can be retrieved from either a local source or a remote repository.
| Parameter | Value | Type | Description |
|---|---|---|---|
urlAtmPre_usr |
gofs | string | username to access the input datasets before the spinup-time from a remote ftp server |
urlAtmPre_pwd |
L##OOkkl!as | string | password to access the input datasets before the spinup-time from a remote ftp server |
urlAtmPre_urlbase |
file:///scratch/surf/indata_offline/ gulfTaranto_20141005/data/data00/ indata/atmosphere/srcFull | string | parametric URL name (i.e. ftp:/... or file:///...) for atmospheric datasets before the spinup-time. Parameters: (FIELD),YYYY(p)MM(p)DD(p) |
urlAtmPre_velU |
v10m | string | name (for zonal air velocity) used to replace the substring (FIELD) on the parametric URL name |
urlAtmPre_velV |
v10m | string | name (for meridional air velocity) used to replace the substring (FIELD) on the parametric URL name |
urlAtmPre_mslp |
mslp | string | name (for mean sea-level pressure) used to replace the substring (FIELD) on the parametric URL name |
urlAtmPre_cloudCov |
tcc | string | name (for total cloud cover) used to replace the substring (FIELD) on the parametric URL name |
urlAtmPre_temp |
t2m | string | name (for air temperature) used to replace the substring (FIELD) on the parametric URL name |
urlAtmPre_dpTemp |
d2m | string | name (for dewpoint temperature) used to replace the substring (FIELD) on the parametric URL name |
urlAtmPre_prec |
precip | string | name (for total precipitation) used to replace the substring (FIELD) on the parametric URL name |
urlAtmPre_tauU |
tauU | string | name (for zonal wind stress) used to replace the substring (FIELD) on the parametric URL name |
urlAtmPre_tauV |
tauV | string | name (for meridional wind stress) used to replace the substring (FIELD) on the parametric URL name |
urlAtmPre_qtot |
qtot | string | name (for total heat flux) used to replace the substring (FIELD) on the parametric URL name |
urlAtmPre_qsr |
qsr | string | name (for solar Radiation Penetration) used to replace the substring (FIELD) on the parametric URL name |
urlAtmPre_emp |
emp | string | name (for mass flux exchanged) used to replace the substring (FIELD) on the parametric URL name |
urlAtmPre_tempS |
sst | string | name (for surface temperature) used to replace the substring (FIELD) on the parametric URL name |
urlAtmPre_salS |
sss | string | name (for surface salinity) used to replace the substring (FIELD) on the parametric URL name |
urlAtmPre_umid |
umid | string | name (for air humidity) used to replace the substring (FIELD) on the parametric URL name |
urlAtmPre_radLW |
lwrd | string | name (for long wave radiation) used to replace the substring (FIELD) on the parametric URL name |
urlAtmPre_radSW |
swrd | string | name (for short wave radiation) used to replace the substring (FIELD) on the parametric URL name |
urlAtmPre_snow |
snow | string | name (for solid precipitation) used to replace the substring (FIELD) on the parametric URL name |
set_dataDownlAtm_fileName_preSpinup¶
This section provides the parameters required to create the filenames for the pre-spinup atmospheric fields datasets. These filenames are used to locate and manage the specific datasets within your data storage system.
| Parameter | Value | Type | Description |
|---|---|---|---|
fileAtmPre_lcompression |
False | bool | enables if datasets you want to download are gzip compressed files (*.gz) |
fileAtmPre_iProdDate |
2 | int | type of production (bulletin) date (=1):fixProdDate, (=2):varProdDate-DayofWeek |
fileAtmPre_dateProdFixed |
20170801 | string | datasets production if iProdDate=1 is used in the URL/files |
fileAtmPre_dateProdDayofWeek |
Wednesday | string | datasets production if iProdDate=2 is used in the URL/files |
fileAtmPre_filebase_velU |
YYYY(i)MM(i)DD(i)-ECMWF---AM0125-MEDATL-bYYYY(i+1)MM(i+1)DD(i+1)_an-fv05.00.nc | string | parametric FILE name for the zonal air velocity datasets before the spinup-time (sbc_iformulat=0,2) |
fileAtmPre_filebase_velV |
YYYY(i)MM(i)DD(i)-ECMWF---AM0125-MEDATL-bYYYY(i+1)MM(i+1)DD(i+1)_an-fv05.00.nc | string | parametric FILE name for the meridional air velocity datasets before the spinup-time (sbc_iformulat=0,2) |
fileAtmPre_filebase_mslp |
YYYY(i)MM(i)DD(i)-ECMWF---AM0125-MEDATL-bYYYY(i+1)MM(i+1)DD(i+1)_an-fv05.00.nc | string | parametric FILE name for the Mean sea-level pressure datasets before the spinup-time (sbc_iformulat=0 or/and sbc_aprdyn) |
fileAtmPre_filebase_cloudCov |
YYYY(i)MM(i)DD(i)-ECMWF---AM0125-MEDATL-bYYYY(i+1)MM(i+1)DD(i+1)_an-fv05.00.nc | string | parametric FILE name for the Total cloud cover datasets before the spinup-time (sbc_iformulat=0) |
fileAtmPre_filebase_temp |
YYYY(i)MM(i)DD(i)-ECMWF---AM0125-MEDATL-bYYYY(i+1)MM(i+1)DD(i+1)_an-fv05.00.nc | string | parametric FILE name for the air temperature datasets before the spinup-time (sbc_iformulat=0,2) |
fileAtmPre_filebase_dpTemp |
YYYY(i)MM(i)DD(i)-ECMWF---AM0125-MEDATL-bYYYY(i+1)MM(i+1)DD(i+1)_an-fv05.00.nc | string | parametric FILE name for the dewpoint temperature datasets before the spinup-time (sbc_iformulat=0) |
fileAtmPre_filebase_prec |
YYYY(i)MM(i)DD(i)_YYYY(i+1)MM(i+1)DD(i+1)-ECMWF---AM025-MEDATL-bYYYY(i)MM(i)DD(i)_fc00-fv02.00_PREC.nc | string | parametric FILE name for the Total precipitation datasets before the spinup-time (sbc_iformulat=0,2) |
fileAtmPre_filebase_tauU |
NOTUSED | string | parametric FILE name for the zonal Wind stress datasets before the spinup-time (sbc_iformulat=1) |
fileAtmPre_filebase_tauV |
NOTUSED | string | parametric FILE name for the meridional Wind stress datasets before the spinup-time (sbc_iformulat=1) |
fileAtmPre_filebase_qtot |
NOTUSED | string | parametric FILE name for the Total heat flux datasets before the spinup-time (sbc_iformulat=1) |
fileAtmPre_filebase_qsr |
NOTUSED | string | parametric FILE name for the Solar Radiation Penetration datasets before the spinup-time (sbc_iformulat=1) |
fileAtmPre_filebase_emp |
NOTUSED | string | parametric FILE name for the Mass flux exchanged datasets before the spinup-time (sbc_iformulat=1) |
fileAtmPre_filebase_tempS |
NOTUSED | string | parametric FILE name for the Surface Temperature datasets before the spinup-time (sbc_iformulat=1) |
fileAtmPre_filebase_salS |
NOTUSED | string | parametric FILE name for the Surface Salinity datasets before the spinup-time (sbc_iformulat=1) |
fileAtmPre_filebase_umid |
NOTUSED | string | parametric FILE name for the Air Umidity datasets before the spinup-time (sbc_iformulat=1) |
fileAtmPre_filebase_radLW |
NOTUSED | string | parametric FILE name for the Long Wave Radiation datasets before the spinup-time (sbc_iformulat=1) |
fileAtmPre_filebase_radSW |
NOTUSED | string | parametric FILE name for the Short Wave Radiation datasets before the spinup-time (sbc_iformulat=1) |
fileAtmPre_filebase_snow |
NOTUSED | string | parametric FILE name for the Solid precipitation datasets before the spinup-time (sbc_iformulat=1) |
set_dataDownlAtm_varName_preSpinup¶
This section details the parameters for specifying the field names of the pre-spinup atmospheric datasets. The field names identify the specific variables within the datasets, ensuring proper data extraction and processing.
| Parameter | Value | Type | Description |
|---|---|---|---|
srcDimAtmPre_lon |
lon | string | name of the dimension for the longitude (sbc_iformulat=0,2) |
srcDimAtmPre_lont |
NOTUSED | string | name of the dimension for the longitude (sbc_iformulat=1) |
srcDimAtmPre_lonu |
NOTUSED | string | name of the dimension for the longitude (sbc_iformulat=1) |
srcDimAtmPre_lonv |
NOTUSED | string | name of the dimension for the longitude (sbc_iformulat=1) |
srcDimAtmPre_lat |
lat | string | name of the dimension for the latitude (sbc_iformulat=0,2) |
srcDimAtmPre_latt |
NOTUSED | string | name of the dimension for the latitude (sbc_iformulat=1) |
srcDimAtmPre_latu |
NOTUSED | string | name of the dimension for the latitude (sbc_iformulat=1) |
srcDimAtmPre_latv |
NOTUSED | string | name of the dimension for the latitude (sbc_iformulat=1) |
srcDimAtmPre_time |
time | string | name of the dimension for the time |
srcCrdAtmPre_lon |
lon | string | name of the variable containing longitude coordinate (sbc_iformulat=0,2) |
srcCrdAtmPre_lont |
NOTUSED | string | name of the variable containing longitude coordinate (sbc_iformulat=1) |
srcCrdAtmPre_lonu |
NOTUSED | string | name of the variable containing longitude coordinate (sbc_iformulat=1) |
srcCrdAtmPre_lonv |
NOTUSED | string | name of the variable containing longitude coordinate (sbc_iformulat=1) |
srcCrdAtmPre_lat |
lat | string | name of the variable containing latitude coordinate (sbc_iformulat=0,2) |
srcCrdAtmPre_latt |
NOTUSED | string | name of the variable containing latitude coordinate (sbc_iformulat=1) |
srcCrdAtmPre_latu |
NOTUSED | string | name of the variable containing latitude coordinate (sbc_iformulat=1) |
srcCrdAtmPre_latv |
NOTUSED | string | name of the variable containing latitude coordinate (sbc_iformulat=1) |
srcCrdAtmPre_time |
time | string | name of the variable containing time coordinate |
srcVarAtmPre_velU |
U10M | string | name of the variable for 10 metre zonal component of air velocity (sbc_iformulat=0,2) |
srcVarAtmPre_velV |
V10M | string | name of the variable for 10 metre meridional component of air velocity (sbc_iformulat=0,2) |
srcVarAtmPre_mslp |
MSL | string | name of the variable for Mean sea-level pressure (sbc_iformulat=0 or/and sbc_aprdyn) |
srcVarAtmPre_cloudCov |
TCC | string | name of the variable for Total cloud cover (sbc_iformulat=0) |
srcVarAtmPre_temp |
T2M | string | name of the variable for 2 metre temperature (sbc_iformulat=0,2) |
srcVarAtmPre_dpTemp |
D2M | string | name of the variable for 2 metre dewpoint temperature (sbc_iformulat=0) |
srcVarAtmPre_prec |
PREC | string | name of the variable for Total precipitation (sbc_iformulat=0,2) |
srcVarAtmPre_tauU |
tauU | string | name of the variable for tauU (sbc_iformulat=1) |
srcVarAtmPre_tauV |
tauV | string | name of the variable for tauV (sbc_iformulat=1) |
srcVarAtmPre_qtot |
qtot | string | name of the variable for qtot (sbc_iformulat=1) |
srcVarAtmPre_qsr |
qsr | string | name of the variable for qsr (sbc_iformulat=1) |
srcVarAtmPre_emp |
emp | string | name of the variable for emp (sbc_iformulat=1) |
srcVarAtmPre_tempS |
tempS | string | name of the variable for tempS (sbc_iformulat=1) |
srcVarAtmPre_salS |
salS | string | name of the variable for salS (sbc_iformulat=1) |
srcVarAtmPre_umid |
q2m | string | name of the variable for 2 metre humidity (sbc_iformulat=2) |
srcVarAtmPre_radLW |
lwrd | string | name of the variable for Long wave radiation (sbc_iformulat=2) |
srcVarAtmPre_radSW |
swrd | string | name of the variable for Short wave radiation (sbc_iformulat=2) |
srcVarAtmPre_snow |
snow | string | name of the variable for Solid precipitation (sbc_iformulat=2) |
set_dataDownlAtm_urlName_postSpinup¶
This section contains the parameters needed to build the URL for accessing post-spinup atmospheric fields datasets. The datasets can be retrieved from either a local source or a remote repository.
| Parameter | Value | Type | Description |
|---|---|---|---|
urlAtmPost_usr |
gofs | string | username to access the input datasets after the spinup-time from a remote ftp server |
urlAtmPost_pwd |
L##OOkkl!as | string | password to access the input datasets after the spinup-time from a remote ftp server |
urlAtmPost_urlbase |
file:///scratch/surf/indata_offline/ gulfTaranto_20141005/data/data00/ indata/atmosphere/srcFull | string | parametric URL name for atmospheric datasets after the spinup-time. Parameters: (FIELD),YYYY(p)MM(p)DD(p) |
urlAtmPost_velU |
v10m | string | name (for zonal air velocity) used to replace the substring (FIELD) on the parametrinc url name |
urlAtmPost_velV |
v10m | string | name (for meridional air velocity) used to replace the substring (FIELD) on the parametrinc url name |
urlAtmPost_mslp |
mslp | string | name (for mean sea-level pressure) used to replace the substring (FIELD) on the parametrinc url name |
urlAtmPost_cloudCov |
tcc | string | name (for total cloud cover) used to replace the substring (FIELD) on the parametrinc url name |
urlAtmPost_temp |
t2m | string | name (for air temperature) used to replace the substring (FIELD) on the parametrinc url name |
urlAtmPost_dpTemp |
d2m | string | name (for dewpoint temperature) used to replace the substring (FIELD) on the parametrinc url name |
urlAtmPost_prec |
precip | string | name (for total precipitation) used to replace the substring (FIELD) on the parametrinc url name |
urlAtmPost_tauU |
tauU | string | name (for zonal wind stress) used to replace the substring (FIELD) on the parametrinc url name |
urlAtmPost_tauV |
tauV | string | name (for meridional wind stress) used to replace the substring (FIELD) on the parametrinc url name |
urlAtmPost_qtot |
qtot | string | name (for total heat flux) used to replace the substring (FIELD) on the parametrinc url name |
urlAtmPost_qsr |
qsr | string | name (for solar Radiation Penetration) used to replace the substring (FIELD) on the parametrinc url name |
urlAtmPost_emp |
emp | string | name (for mass flux exchanged) used to replace the substring (FIELD) on the parametrinc url name |
urlAtmPost_tempS |
sst | string | name (for surface temperature) used to replace the substring (FIELD) on the parametrinc url name |
urlAtmPost_salS |
sss | string | name (for surface salinity) used to replace the substring (FIELD) on the parametrinc url name |
urlAtmPost_umid |
umid | string | name (for air umidity) used to replace the substring (FIELD) on the parametrinc url name |
urlAtmPost_radLW |
lwrd | string | name (for long wave radiation) used to replace the substring (FIELD) on the parametrinc url name |
urlAtmPost_radSW |
swrd | string | name (for short wave radiation) used to replace the substring (FIELD) on the parametrinc url name |
urlAtmPost_snow |
snow | string | name (for solid precipitation) used to replace the substring (FIELD) on the parametrinc url name |
set_dataDownlAtm_fileName_postSpinup¶
This section provides the parameters required to create the filenames for the post-spinup atmospheric fields datasets. These filenames are used to locate and manage the specific datasets within your data storage system.
| Parameter | Value | Type | Description |
|---|---|---|---|
fileAtmPost_lcompression |
False | bool | enables if datasets you want to download are gzip compressed files (*.gz) |
fileAtmPost_iProdDate |
2 | int | type of production (bulletin) date (=1):fixProdDate, (=2):varProdDate-DayofWeek |
fileAtmPost_dateProdFixed |
20170801 | string | datasets production if iProdDate=1 is used in the URL/files |
fileAtmPost_dateProdDayofWeek |
Wednesday | string | datasets production if iProdDate=2 is used in the URL/files |
fileAtmPost_filebase_velU |
YYYY(i)MM(i)DD(i)-ECMWF---AM0125-MEDATL-bYYYY(i+1)MM(i+1)DD(i+1)_an-fv05.00.nc | string | parametric FILE name for the zonal air velocity datasets after the spinup-time |
fileAtmPost_filebase_velV |
YYYY(i)MM(i)DD(i)-ECMWF---AM0125-MEDATL-bYYYY(i+1)MM(i+1)DD(i+1)_an-fv05.00.nc | string | parametric FILE name for the meridional air velocity datasets after the spinup-time |
fileAtmPost_filebase_mslp |
YYYY(i)MM(i)DD(i)-ECMWF---AM0125-MEDATL-bYYYY(i+1)MM(i+1)DD(i+1)_an-fv05.00.nc | string | parametric FILE name for the Mean sea-level pressure datasets after the spinup-time |
fileAtmPost_filebase_cloudCov |
YYYY(i)MM(i)DD(i)-ECMWF---AM0125-MEDATL-bYYYY(i+1)MM(i+1)DD(i+1)_an-fv05.00.nc | string | parametric FILE name for the Total cloud cover datasets after the spinup-time |
fileAtmPost_filebase_temp |
YYYY(i)MM(i)DD(i)-ECMWF---AM0125-MEDATL-bYYYY(i+1)MM(i+1)DD(i+1)_an-fv05.00.nc | string | parametric FILE name for the air temperature datasets after the spinup-time |
fileAtmPost_filebase_dpTemp |
YYYY(i)MM(i)DD(i)-ECMWF---AM0125-MEDATL-bYYYY(i+1)MM(i+1)DD(i+1)_an-fv05.00.nc | string | parametric FILE name for the dewpoint temperature datasets after the spinup-time |
fileAtmPost_filebase_prec |
YYYY(i)MM(i)DD(i)_YYYY(i+1)MM(i+1)DD(i+1)-ECMWF---AM025-MEDATL-bYYYY(i)MM(i)DD(i)_fc00-fv02.00_PREC.nc | string | parametric FILE name for the Total precipitation datasets after the spinup-time |
fileAtmPost_filebase_tauU |
NOTUSED | string | parametric FILE name for the zonal Wind stress datasets after the spinup-time |
fileAtmPost_filebase_tauV |
NOTUSED | string | parametric FILE name for the meridional Wind stress datasets after the spinup-time |
fileAtmPost_filebase_qtot |
NOTUSED | string | parametric FILE name for the Total heat flux datasets after the spinup-time |
fileAtmPost_filebase_qsr |
NOTUSED | string | parametric FILE name for the Solar Radiation Penetration datasets after the spinup-time |
fileAtmPost_filebase_emp |
NOTUSED | string | parametric FILE name for the Mass flux exchanged datasets after the spinup-time |
fileAtmPost_filebase_tempS |
NOTUSED | string | parametric FILE name for the Surface Temperature datasets after the spinup-time |
fileAtmPost_filebase_salS |
NOTUSED | string | parametric FILE name for the Surface Salinity datasets after the spinup-time |
fileAtmPost_filebase_umid |
NOTUSED | string | parametric FILE name for the Air Umidity datasets after the spinup-time |
fileAtmPost_filebase_radLW |
NOTUSED | string | parametric FILE name for the Long Wave Radiation datasets after the spinup-time |
fileAtmPost_filebase_radSW |
NOTUSED | string | parametric FILE name for the Short Wave Radiation datasets after the spinup-time |
fileAtmPost_filebase_snow |
NOTUSED | string | parametric FILE name for the Solid precipitation datasets after the spinup-time |
set_dataDownlAtm_varName_postSpinup¶
This section details the parameters for specifying the field names of the post-spinup atmospheric datasets. The field names identify the specific variables within the datasets, ensuring proper data extraction and processing.
| Parameter | Value | Type | Description |
|---|---|---|---|
srcDimAtmPost_lon |
lon | string | name of the dimension for the longitude (sbc_iformulat=0,2) |
srcDimAtmPost_lont |
lon | string | name of the dimension for the longitude (sbc_iformulat=1) |
srcDimAtmPost_lonu |
NOTUSED | string | name of the dimension for the longitude (sbc_iformulat=1) |
srcDimAtmPost_lonv |
NOTUSED | string | name of the dimension for the longitude (sbc_iformulat=1) |
srcDimAtmPost_lat |
lat | string | name of the dimension for the latitude (sbc_iformulat=0,2) |
srcDimAtmPost_latt |
lat | string | name of the dimension for the latitude (sbc_iformulat=1) |
srcDimAtmPost_latu |
NOTUSED | string | name of the dimension for the latitude (sbc_iformulat=1) |
srcDimAtmPost_latv |
NOTUSED | string | name of the dimension for the latitude (sbc_iformulat=1) |
srcDimAtmPost_time |
time | string | name of the dimension for the time |
srcCrdAtmPost_lon |
lon | string | name of the variable containing longitude coordinate (sbc_iformulat=0,2) |
srcCrdAtmPost_lont |
lon | string | name of the variable containing longitude coordinate (sbc_iformulat=1) |
srcCrdAtmPost_lonu |
NOTUSED | string | name of the variable containing longitude coordinate (sbc_iformulat=1) |
srcCrdAtmPost_lonv |
NOTUSED | string | name of the variable containing longitude coordinate (sbc_iformulat=1) |
srcCrdAtmPost_lat |
lat | string | name of the variable containing latitude coordinate (sbc_iformulat=0,2) |
srcCrdAtmPost_latt |
lat | string | name of the variable containing latitude coordinate (sbc_iformulat=1) |
srcCrdAtmPost_latu |
NOTUSED | string | name of the variable containing latitude coordinate (sbc_iformulat=1) |
srcCrdAtmPost_latv |
NOTUSED | string | name of the variable containing latitude coordinate (sbc_iformulat=1) |
srcCrdAtmPost_time |
time | string | name of the variable containing time coordinate |
srcVarAtmPost_velU |
U10M | string | name of the variable for 10 metre zonal component of air velocity (sbc_iformulat=0,2) |
srcVarAtmPost_velV |
V10M | string | name of the variable for 10 metre meridional component of air velocity (sbc_iformulat=0,2) |
srcVarAtmPost_mslp |
MSL | string | name of the variable for Mean sea-level pressure (sbc_iformulat=0 or/and sbc_aprdyn) |
srcVarAtmPost_cloudCov |
TCC | string | name of the variable for Total cloud cover (sbc_iformulat=0) |
srcVarAtmPost_temp |
T2M | string | name of the variable for 2 metre temperature (sbc_iformulat=0,2) |
srcVarAtmPost_dpTemp |
D2M | string | name of the variable for 2 metre dewpoint temperature (sbc_iformulat=0) |
srcVarAtmPost_prec |
PREC | string | name of the variable for Total precipitation (sbc_iformulat=0,2) |
srcVarAtmPost_tauU |
tauU | string | name of the variable for tauU (sbc_iformulat=1) |
srcVarAtmPost_tauV |
tauV | string | name of the variable for tauV (sbc_iformulat=1) |
srcVarAtmPost_qtot |
qtot | string | name of the variable for qtot (sbc_iformulat=1) |
srcVarAtmPost_qsr |
qsr | string | name of the variable for qsr (sbc_iformulat=1) |
srcVarAtmPost_emp |
emp | string | name of the variable for emp (sbc_iformulat=1) |
srcVarAtmPost_tempS |
tempS | string | name of the variable for tempS (sbc_iformulat=1) |
srcVarAtmPost_salS |
salS | string | name of the variable for salS (sbc_iformulat=1) |
srcVarAtmPost_umid |
q2m | string | name of the variable for 2 metre umidity (sbc_iformulat=2) |
srcVarAtmPost_radLW |
lwrd | string | name of the variable for Long wave radiation (sbc_iformulat=2) |
srcVarAtmPost_radSW |
swrd | string | name of the variable for Short wave radiation (sbc_iformulat=2) |
srcVarAtmPost_snow |
snow | string | name of the variable for Solid precipitation (sbc_iformulat=2) |
set_dataDownlOceICMesh_urlName¶
This section defines the parameters used to construct the URL for accessing Ocean Initial Condition meshmask datasets. These datasets can be sourced from either a local directory or a remote repository.
| Parameter | Value | Type | Description |
|---|---|---|---|
urlOceICMesh_usr |
gofs | string | username to access the datasets from a remote ftp server |
urlOceICMesh_pwd |
L##OOkkl!as | string | password to access the datasets from a remote ftp server |
urlOceICMesh_urlbase |
file:///scratch/surf/indata_offline/ gulfTaranto_20141005/data/data00/ indata/ocean/oceanIC/srcFull | string | parametric URL (ftp:/ or file:///) name for ocean input IC-meshmask datasets. Parameters: (FIELD) |
urlOceICMesh_lont |
glamt | string | name (for longitude-Tgrid) used to replace the substring (FIELD) on the parametric URL name |
urlOceICMesh_lonu |
glamu | string | name (for longitude-Ugrid) used to replace the substring (FIELD) on the parametric URL name |
urlOceICMesh_lonv |
glamv | string | name (for longitude-Vgrid) used to replace the substring (FIELD) on the parametric URL name |
urlOceICMesh_lonf |
glamf | string | name (for longitude-Fgrid) used to replace the substring (FIELD) on the parametric URL name |
urlOceICMesh_latt |
gphit | string | name (for latitude-Tgrid) used to replace the substring (FIELD) on the parametric URL name |
urlOceICMesh_latu |
gphiu | string | name (for latitude-Ugrid) used to replace the substring (FIELD) on the parametric URL name |
urlOceICMesh_latv |
gphiv | string | name (for latitude-Vgrid) used to replace the substring (FIELD) on the parametric URL name |
urlOceICMesh_latf |
gphif | string | name (for latitude-Fgrid) used to replace the substring (FIELD) on the parametric URL name |
urlOceICMesh_deptht1d |
gdept_0 | string | name (for depth-Tgrid) used to replace the substring (FIELD) on the parametric URL name |
urlOceICMesh_depthw1d |
gdepw_0 | string | name (for depth-Wgrid) used to replace the substring (FIELD) on the parametric URL name |
urlOceICMesh_xscalfctt |
e1t | string | name (for scaleFactor-Tgrid x-direction) used to replace the substring (FIELD) on the parametric URL name |
urlOceICMesh_xscalfctu |
e1u | string | name (for scaleFactor-Ugrid x-direction) used to replace the substring (FIELD) on the parametric URL name |
urlOceICMesh_xscalfctv |
e1v | string | name (for scaleFactor-Vgrid x-direction) used to replace the substring (FIELD) on the parametric URL name |
urlOceICMesh_xscalfctf |
e1f | string | name (for scaleFactor-Fgrid x-direction) used to replace the substring (FIELD) on the parametric URL name |
urlOceICMesh_yscalfctt |
e2t | string | name (for scaleFactor-Tgrid y-direction) used to replace the substring (FIELD) on the parametric URL name |
urlOceICMesh_yscalfctu |
e2u | string | name (for scaleFactor-Ugrid y-direction) used to replace the substring (FIELD) on the parametric URL name |
urlOceICMesh_yscalfctv |
e2v | string | name (for scaleFactor-Vgrid y-direction) used to replace the substring (FIELD) on the parametric URL name |
urlOceICMesh_yscalfctf |
e2f | string | name (for scaleFactor-Fgrid y-direction) used to replace the substring (FIELD) on the parametric URL name |
urlOceICMesh_zscalfctt1d |
e3t_0 | string | name (for scaleFactor-Tgrid z-direction) used to replace the substring (FIELD) on the parametric URL name |
urlOceICMesh_zscalfctw1d |
e3w_0 | string | name (for scaleFactor-Wgrid z-direction) used to replace the substring (FIELD) on the parametric URL name |
urlOceICMesh_maskt |
tmask | string | name (for LandSea-mask-Tgrid) used to replace the substring (FIELD) on the parametric URL name |
urlOceICMesh_masku |
umask | string | name (for LandSea-mask-Ugrid) used to replace the substring (FIELD) on the parametric URL name |
urlOceICMesh_maskv |
vmask | string | name (for LandSea-mask-Vgrid) used to replace the substring (FIELD) on the parametric URL name |
set_dataDownlOceICMesh_fileName¶
This section specifies the parameters required to generate the filenames of the Ocean Initial Condition meshmask datasets. These filenames help identify the relevant files in the storage location.
| Parameter | Value | Type | Description |
|---|---|---|---|
fileOceICMesh_filebase |
meshmask_SYS4a3_IONIAN.nc | string | parametric FILE name for ocean source input data. Parameters: (FIELD) |
fileOceICMesh_lcompression |
False | bool | enables if datasets you want to download are gzip compressed files (*.gz) |
fileOceICMesh_llonFlip |
False | bool | (=True) if longitude coord. is in the 0 to 360 range (=True) if longitude is in -180:+180 range |
fileOceICMesh_llonCycl |
True | bool | Logical variable=True if you use global data and longitude is cyclic |
fileOceICMesh_llatInv |
False | bool | enables if the dataset contains latitude decreasing through the pole |
fileOceICMesh_lont |
coordinates | string | name (for longitude-Tgrid) used to replace the substring (FIELD) on the parametric URL name |
fileOceICMesh_lonu |
coordinates | string | name (for longitude-Ugrid) used to replace the substring (FIELD) on the parametric URL name |
fileOceICMesh_lonv |
coordinates | string | name (for longitude-Vgrid) used to replace the substring (FIELD) on the parametric URL name |
fileOceICMesh_lonf |
coordinates | string | name (for longitude-Fgrid) used to replace the substring (FIELD) on the parametric URL name |
fileOceICMesh_latt |
coordinates | string | name (for latitude-Tgrid) used to replace the substring (FIELD) on the parametric URL name |
fileOceICMesh_latu |
coordinates | string | name (for latitude-Ugrid) used to replace the substring (FIELD) on the parametric URL name |
fileOceICMesh_latv |
coordinates | string | name (for latitude-Vgrid) used to replace the substring (FIELD) on the parametric URL name |
fileOceICMesh_latf |
coordinates | string | name (for latitude-Fgrid) used to replace the substring (FIELD) on the parametric URL name |
fileOceICMesh_deptht1d |
meshmask_vertical | string | name (for depth-Tgrid) used to replace the substring (FIELD) on the parametric URL name |
fileOceICMesh_depthw1d |
meshmask_vertical | string | name (for depth-Wgrid) used to replace the substring (FIELD) on the parametric URL name |
fileOceICMesh_xscalfctt |
coordinates | string | name (for scaleFactor-Tgrid x-direction) used to replace the substring (FIELD) on the parametric URL name |
fileOceICMesh_xscalfctu |
coordinates | string | name (for scaleFactor-Ugrid x-direction) used to replace the substring (FIELD) on the parametric URL name |
fileOceICMesh_xscalfctv |
coordinates | string | name (for scaleFactor-Vgrid x-direction) used to replace the substring (FIELD) on the parametric URL name |
fileOceICMesh_xscalfctf |
coordinates | string | name (for scaleFactor-Fgrid x-direction) used to replace the substring (FIELD) on the parametric URL name |
fileOceICMesh_yscalfctt |
coordinates | string | name (for scaleFactor-Tgrid y-direction) used to replace the substring (FIELD) on the parametric URL name |
fileOceICMesh_yscalfctu |
coordinates | string | name (for scaleFactor-Ugrid y-direction) used to replace the substring (FIELD) on the parametric URL name |
fileOceICMesh_yscalfctv |
coordinates | string | name (for scaleFactor-Vgrid y-direction) used to replace the substring (FIELD) on the parametric URL name |
fileOceICMesh_yscalfctf |
coordinates | string | name (for scaleFactor-Fgrid y-direction) used to replace the substring (FIELD) on the parametric URL name |
fileOceICMesh_zscalfctt1d |
meshmask_vertical | string | name (for scaleFactor-Tgrid z-direction) used to replace the substring (FIELD) on the parametric URL name |
fileOceICMesh_zscalfctw1d |
meshmask_vertical | string | name (for scaleFactor-Wgrid z-direction) used to replace the substring (FIELD) on the parametric URL name |
fileOceICMesh_maskt |
mesh_tmask | string | name (for LandSea-mask-Tgrid) used to replace the substring (FIELD) on the parametric URL name |
fileOceICMesh_masku |
mesh_umask | string | name (for LandSea-mask-Ugrid) used to replace the substring (FIELD) on the parametric URL name |
fileOceICMesh_maskv |
mesh_vmask | string | name (for LandSea-mask-Vgrid) used to replace the substring (FIELD) on the parametric URL name |
fileOceICMesh_lkeepSrcFull |
True | bool | enables if you want keep the downloaded uncutted datasets |
set_dataDownlOceICMesh_varName¶
This section outlines the parameters related to the variable names used within the Ocean Initial Condition meshmask datasets. These variable names are crucial for accurately extracting and utilizing the data within the files.
| Parameter | Value | Type | Description |
|---|---|---|---|
srcDimOceICMesh_lont |
x | string | name of the dimension for the longitude |
srcDimOceICMesh_lonu |
x | string | name of the dimension for the longitude |
srcDimOceICMesh_lonv |
x | string | name of the dimension for the longitude |
srcDimOceICMesh_lonw |
x | string | name of the dimension for the longitude |
srcDimOceICMesh_latt |
y | string | name of the dimension for the latitude |
srcDimOceICMesh_latu |
y | string | name of the dimension for the latitude |
srcDimOceICMesh_latv |
y | string | name of the dimension for the latitude |
srcDimOceICMesh_latw |
y | string | name of the dimension for the latitude |
srcDimOceICMesh_deptht |
z | string | name of the dimension for the depth |
srcDimOceICMesh_depthu |
z | string | name of the dimension for the depth |
srcDimOceICMesh_depthv |
z | string | name of the dimension for the depth |
srcDimOceICMesh_depthw |
z | string | name of the dimension for the depth |
srcDimOceICMesh_time |
t | string | name of the dimension for the time |
srcCrdOceICMesh_lont |
nav_lon | string | name of the coordinate variable for the longitude |
srcCrdOceICMesh_lonu |
nav_lon | string | name of the coordinate variable for the longitude |
srcCrdOceICMesh_lonv |
nav_lon | string | name of the coordinate variable for the longitude |
srcCrdOceICMesh_latt |
nav_lat | string | name of the coordinate variable for the latitude |
srcCrdOceICMesh_latu |
nav_lat | string | name of the coordinate variable for the latitude |
srcCrdOceICMesh_latv |
nav_lat | string | name of the coordinate variable for the latitude |
srcCrdOceICMesh_deptht |
nav_lev | string | name of the coordinate variable for the depth |
srcCrdOceICMesh_depthw |
nav_lev | string | name of the coordinate variable for the depth |
srcCrdOceICMesh_time |
time_counter | string | name of the coordinate variable for the time |
srcVarOceICMesh_lont |
glamt | string | name of the variable containing longitude coordinate |
srcVarOceICMesh_lonu |
glamu | string | name of the variable containing longitude coordinate |
srcVarOceICMesh_lonv |
glamv | string | name of the variable containing longitude coordinate |
srcVarOceICMesh_lonf |
glamf | string | name of the variable containing longitude coordinate |
srcVarOceICMesh_latt |
gphit | string | name of the variable containing latitude coordinate |
srcVarOceICMesh_latu |
gphiu | string | name of the variable containing latitude coordinate |
srcVarOceICMesh_latv |
gphiv | string | name of the variable containing latitude coordinate |
srcVarOceICMesh_latf |
gphif | string | name of the variable containing latitude coordinate |
srcVarOceICMesh_deptht1d |
gdept_0 | string | name of the variable containing depth coordinate |
srcVarOceICMesh_depthw1d |
gdepw_0 | string | name of the variable containing depth coordinate |
srcVarOceICMesh_xscalfctt |
e1t | string | name of the scale factors in zonal direction |
srcVarOceICMesh_xscalfctu |
e1u | string | name of the scale factors in zonal direction |
srcVarOceICMesh_xscalfctv |
e1v | string | name of the scale factors in zonal direction |
srcVarOceICMesh_xscalfctf |
e1f | string | name of the scale factors in zonal direction |
srcVarOceICMesh_yscalfctt |
e2t | string | name of the scale factors in meridional direction |
srcVarOceICMesh_yscalfctu |
e2u | string | name of the scale factors in meridional direction |
srcVarOceICMesh_yscalfctv |
e2v | string | name of the scale factors in meridional direction |
srcVarOceICMesh_yscalfctf |
e2f | string | name of the scale factors in meridional direction |
srcVarOceICMesh_zscalfctt1d |
e3t_0 | string | name of the scale factors in vertical direction |
srcVarOceICMesh_zscalfctw1d |
e3w_0 | string | name of the scale factors in vertical direction |
srcVarOceICMesh_maskt |
tmask | string | name of the land-sea-mask on T-points |
srcVarOceICMesh_masku |
umask | string | name of the land-sea-mask on U-points |
srcVarOceICMesh_maskv |
vmask | string | name of the land-sea-mask on V-points |
set_dataDownlOceIC_urlName¶
This section contains the parameters needed to build the URL for accessing Ocean Initial Condition fields datasets. The datasets can be retrieved from either a local source or a remote repository.
| Parameter | Value | Type | Description |
|---|---|---|---|
urlOceIC_usr |
gofs | string | Username to access the datasets from a remote FTP server |
urlOceIC_pwd |
L##OOkkl!as | string | Password to access the datasets from a remote FTP server |
urlOceIC_urlbase |
file:///scratch/surf/indata_offline/ gulfTaranto_20141005/data/data00/ indata/ocean/oceanIC/srcFull | string | Parametric URL (ftp:/ or file:///) name for ocean input IC datasets. Parameters: (FIELD), YYYY(p)MM(p)DD(p), YYYY(i)MM(i)DD(i), YYYY(i-1)MM(i-1)DD(i-1), YYYY(i+1)MM(i+1)DD(i+1) |
urlOceIC_temp |
tem | string | Name (for Temperature) used to replace the substring (FIELD) on the parametric URL name |
urlOceIC_sal |
sal | string | Name (for Salinity) used to replace the substring (FIELD) on the parametric URL name |
urlOceIC_ssh |
ssh | string | Name (for Sea Surface Height) used to replace the substring (GRID) on the parametric URL name |
urlOceIC_velU |
cur | string | Name (for Zonal Current) used to replace the substring (GRID) on the parametric URL name |
urlOceIC_velV |
cur | string | Name (for Meridional Current) used to replace the substring (FIELD) on the parametric URL name |
urlOceIC_tempGrid |
gridT | string | Name (for Temperature) used to replace the substring (GRID) on the parametric URL name |
urlOceIC_salGrid |
gridT | string | Name (for Salinity) used to replace the substring (GRID) on the parametric URL name |
urlOceIC_sshGrid |
gridT | string | Name (for Sea Surface Height) used to replace the substring (GRID) on the parametric URL name |
urlOceIC_velUGrid |
gridU | string | Name (for Zonal Current) used to replace the substring (GRID) on the parametric URL name |
urlOceIC_velVGrid |
gridV | string | Name (for Meridional Current) used to replace the substring (GRID) on the parametric URL name |
set_dataDownlOceIC_fileName¶
This section provides the parameters required to create the filenames for the pre-spinup Ocean Initial Condition fields datasets. These filenames are used to locate and manage the specific datasets within your data storage system.
| Parameter | Value | Type | Description |
|---|---|---|---|
fileOceIC_filebase |
EXP1_EAS1_1d_YYYY(i)MM(i)DD(i)_ YYYY(i+1)MM(i+1)DD(i+1)_(GRID)_IONIAN.nc | string | Parametric FILE name for ocean source input data. Parameters: (GRID),(FIELD),YYYY(p)MM(p)DD(p),YYYY(i)MM(i)DD(i),YYYY(i-1)MM(i-1)DD(i-1),YYYY(i+1)MM(i+1)DD(i+1) |
fileOceIC_lcompression |
False | bool | Enables if datasets you want to download are gzip compressed files (*.gz) |
fileOceIC_iProdDate |
1 | int | File name format to be downloaded (=1):fixProdDate, (=2):varProdDate-DayofWeek |
fileOceIC_dateProdFixed |
20170801 | string | Datasets production if iProdDate=1 is used in the URL/files |
fileOceIC_dateProdDayofWeek |
Wednesday | string | Datasets production if iProdDate=2 is used in the URL/files |
fileOceIC_temp |
_votemper | string | Name (for Temperature) used to replace the substring (FIELD) on the parametric file name |
fileOceIC_sal |
_vosaline | string | Name (for Salinity) used to replace the substring (FIELD) on the parametric file name |
fileOceIC_ssh |
2D | string | Name (for Sea Surface Height) used to replace the substring (FIELD) on the parametric file name |
fileOceIC_velU |
_vozocrtx | string | Name (for Zonal Current) used to replace the substring (FIELD) on the parametric file name |
fileOceIC_velV |
_vomecrty | string | Name (for Meridional Current) used to replace the substring (FIELD) on the parametric file name |
fileOceIC_tempGrid |
grid_T | string | Name (for Temperature) used to replace the substring (GRID) on the parametric file name |
fileOceIC_salGrid |
grid_T | string | Name (for Salinity) used to replace the substring (GRID) on the parametric file name |
fileOceIC_sshGrid |
grid_T | string | Name (for Sea Surface Height) used to replace the substring (GRID) on the parametric file name |
fileOceIC_velUGrid |
grid_U | string | Name (for Zonal Current) used to replace the substring (GRID) on the parametric file name |
fileOceIC_velVGrid |
grid_V | string | Name (for Meridional Current) used to replace the substring (GRID) on the parametric file name |
set_dataDownlOceIC_varName¶
This section details the parameters for specifying the field names of the Ocean Initial Condition datasets. The field names identify the specific variables within the datasets, ensuring proper data extraction and processing.
| Parameter | Value | Type | Description |
|---|---|---|---|
srcDimOceIC_lont |
x | string | Name of the dimension for the longitude |
srcDimOceIC_lonu |
x | string | Name of the dimension for the longitude |
srcDimOceIC_lonv |
x | string | Name of the dimension for the longitude |
srcDimOceIC_lonw |
x | string | Name of the dimension for the longitude |
srcDimOceIC_latt |
y | string | Name of the dimension for the latitude |
srcDimOceIC_latu |
y | string | Name of the dimension for the latitude |
srcDimOceIC_latv |
y | string | Name of the dimension for the latitude |
srcDimOceIC_latw |
y | string | Name of the dimension for the latitude |
srcDimOceIC_deptht |
deptht | string | Name of the dimension for the depth |
srcDimOceIC_depthu |
depthu | string | Name of the dimension for the depth |
srcDimOceIC_depthv |
depthv | string | Name of the dimension for the depth |
srcDimOceIC_depthw |
depthw | string | Name of the dimension for the depth |
srcDimOceIC_time |
t | string | Name of the dimension for the time |
srcCrdOceIC_lont |
nav_lon | string | Name of the coordinate variable for the longitude coordinate |
srcCrdOceIC_lonu |
nav_lon | string | Name of the coordinate variable for the longitude coordinate |
srcCrdOceIC_lonv |
nav_lon | string | Name of the coordinate variable for the longitude coordinate |
srcCrdOceIC_lonw |
nav_lon | string | Name of the coordinate variable for the longitude coordinate |
srcCrdOceIC_latt |
nav_lat | string | Name of the coordinate variable for the latitude coordinate |
srcCrdOceIC_latu |
nav_lat | string | Name of the coordinate variable for the latitude coordinate |
srcCrdOceIC_latv |
nav_lat | string | Name of the coordinate variable for the latitude coordinate |
srcCrdOceIC_latw |
nav_lat | string | Name of the coordinate variable for the latitude coordinate |
srcCrdOceIC_deptht |
deptht | string | Name of the coordinate variable for the depth coordinate |
srcCrdOceIC_depthu |
depthu | string | Name of the coordinate variable for the depth coordinate |
srcCrdOceIC_depthv |
depthv | string | Name of the coordinate variable for the depth coordinate |
srcCrdOceIC_depthw |
depthw | string | Name of the coordinate variable for the depth coordinate |
srcCrdOceIC_time |
time_counter | string | Name of the coordinate variable for the time coordinate |
srcVarOceIC_temp |
votemper | string | Name of the variable for the Temperature |
srcVarOceIC_sal |
vosaline | string | Name of the variable for the Salinity |
srcVarOceIC_ssh |
sossheig | string | Name of the variable for the Sea Surface Height |
srcVarOceIC_velU |
vozocrtx | string | Name of the variable for the Zonal Current |
srcVarOceIC_velV |
vomecrty | string | Name of the variable for the Merid. Current |
set_dataDownlOceBCMesh_urlName¶
This section defines the parameters used to construct the URL for accessing Ocean Open Boundary Condition meshmask datasets. These datasets can be sourced from either a local directory or a remote repository.
| Parameter | Value | Type | Description |
|---|---|---|---|
urlOceBCMesh_usr |
gofs | string | Username to access the datasets from a remote FTP server |
urlOceBCMesh_pwd |
L##OOkkl!as | string | Password to access the datasets from a remote FTP server |
urlOceBCMesh_urlbase |
file:///scratch/surf/indata_offline/ gulfTaranto_20141005/data/data00/ indata/ocean/oceanBC/srcFull | string | Parametric URL (ftp:/ or file:///) name for ocean input BC-meshmask datasets |
urlOceBCMesh_lont |
glamt | string | Longitude-Tgrid used to replace the substring (FIELD) on the parametric URL name |
urlOceBCMesh_lonu |
glamu | string | Longitude-Ugrid used to replace the substring (FIELD) on the parametric URL name |
urlOceBCMesh_lonv |
glamv | string | Longitude-Vgrid used to replace the substring (FIELD) on the parametric URL name |
urlOceBCMesh_lonf |
glamf | string | Longitude-Fgrid used to replace the substring (FIELD) on the parametric URL name |
urlOceBCMesh_latt |
gphit | string | Latitude-Tgrid used to replace the substring (FIELD) on the parametric URL name |
urlOceBCMesh_latu |
gphiu | string | Latitude-Ugrid used to replace the substring (FIELD) on the parametric URL name |
urlOceBCMesh_latv |
gphiv | string | Latitude-Vgrid used to replace the substring (FIELD) on the parametric URL name |
urlOceBCMesh_latf |
gphif | string | Latitude-Fgrid used to replace the substring (FIELD) on the parametric URL name |
urlOceBCMesh_deptht1d |
gdept_0 | string | Depth-Tgrid used to replace the substring (FIELD) on the parametric URL name |
urlOceBCMesh_depthw1d |
gdepw_0 | string | Depth-Wgrid used to replace the substring (FIELD) on the parametric URL name |
urlOceBCMesh_xscalfctt |
e1t | string | Scale factor-Tgrid in the x-direction |
urlOceBCMesh_xscalfctu |
e1u | string | Scale factor-Ugrid in the x-direction |
urlOceBCMesh_xscalfctv |
e1v | string | Scale factor-Vgrid in the x-direction |
urlOceBCMesh_xscalfctf |
e1f | string | Scale factor-Fgrid in the x-direction |
urlOceBCMesh_yscalfctt |
e2t | string | Scale factor-Tgrid in the y-direction |
urlOceBCMesh_yscalfctu |
e2u | string | Scale factor-Ugrid in the y-direction |
urlOceBCMesh_yscalfctv |
e2v | string | Scale factor-Vgrid in the y-direction |
urlOceBCMesh_yscalfctf |
e2f | string | Scale factor-Fgrid in the y-direction |
urlOceBCMesh_zscalfctt1d |
e3t_0 | string | Scale factor-Tgrid in the z-direction (1D) |
urlOceBCMesh_zscalfctw1d |
e3w_0 | string | Scale factor-Wgrid in the z-direction (1D) |
urlOceBCMesh_zscalfctu |
e3u | string | Scale factor-Ugrid in the z-direction (3D) |
urlOceBCMesh_zscalfctv |
e3v | string | Scale factor-Vgrid in the z-direction (3D) |
urlOceBCMesh_maskt |
tmask | string | LandSea-mask for the T-grid |
urlOceBCMesh_masku |
umask | string | LandSea-mask for the U-grid |
urlOceBCMesh_maskv |
vmask | string | LandSea-mask for the V-grid |
set_dataDownlOceBCMesh_fileName¶
This section specifies the parameters required to generate the filenames of the Ocean Open Boundary Condition meshmask datasets. These filenames help identify the relevant files in the storage location.
| Parameter | Value | Type | Description |
|---|---|---|---|
fileOceBCMesh_filebase |
meshmask_SYS4a3_IONIAN.nc | string | Parametric FILE name for ocean source input data. Parameters: (FIELD) |
fileOceBCMesh_lcompression |
False | bool | Enables if datasets you want to download are gzip compressed files (*.gz) |
fileOceBCMesh_llonFlip |
False | bool | (=True) if longitude coord. is in the 0 to 360 range (=True) if longitude is in -180:+180 range |
fileOceBCMesh_llonCycl |
True | bool | Logical variable=True if you use global data and longitude is cyclic |
fileOceBCMesh_llatInv |
False | bool | Enables if the dataset contains latitude decreasing through the pole |
fileOceBCMesh_lont |
coordinates | string | Name (for longitude-Tgrid) used to replace the substring (FIELD) on the parametric URL name |
fileOceBCMesh_lonu |
coordinates | string | Name (for longitude-Ugrid) used to replace the substring (FIELD) on the parametric URL name |
fileOceBCMesh_lonv |
coordinates | string | Name (for longitude-Vgrid) used to replace the substring (FIELD) on the parametric URL name |
fileOceBCMesh_lonf |
coordinates | string | Name (for longitude-Fgrid) used to replace the substring (FIELD) on the parametric URL name |
fileOceBCMesh_latt |
coordinates | string | Name (for latitude-Tgrid) used to replace the substring (FIELD) on the parametric URL name |
fileOceBCMesh_latu |
coordinates | string | Name (for latitude-Ugrid) used to replace the substring (FIELD) on the parametric URL name |
fileOceBCMesh_latv |
coordinates | string | Name (for latitude-Vgrid) used to replace the substring (FIELD) on the parametric URL name |
fileOceBCMesh_latf |
coordinates | string | Name (for latitude-Fgrid) used to replace the substring (FIELD) on the parametric URL name |
fileOceBCMesh_deptht1d |
meshmask_vertical | string | Name (for depth-Tgrid) used to replace the substring (FIELD) on the parametric URL name |
fileOceBCMesh_depthw1d |
meshmask_vertical | string | Name (for depth-Wgrid) used to replace the substring (FIELD) on the parametric URL name |
fileOceBCMesh_xscalfctt |
coordinates | string | Name (for scaleFactor-Tgrid x-direction) used to replace the substring (FIELD) on the parametric URL name |
fileOceBCMesh_xscalfctu |
coordinates | string | Name (for scaleFactor-Ugrid x-direction) used to replace the substring (FIELD) on the parametric URL name |
fileOceBCMesh_xscalfctv |
coordinates | string | Name (for scaleFactor-Vgrid x-direction) used to replace the substring (FIELD) on the parametric URL name |
fileOceBCMesh_xscalfctf |
coordinates | string | Name (for scaleFactor-Fgrid x-direction) used to replace the substring (FIELD) on the parametric URL name |
fileOceBCMesh_yscalfctt |
coordinates | string | Name (for scaleFactor-Tgrid y-direction) used to replace the substring (FIELD) on the parametric URL name |
fileOceBCMesh_yscalfctu |
coordinates | string | Name (for scaleFactor-Ugrid y-direction) used to replace the substring (FIELD) on the parametric URL name |
fileOceBCMesh_yscalfctv |
coordinates | string | Name (for scaleFactor-Vgrid y-direction) used to replace the substring (FIELD) on the parametric URL name |
fileOceBCMesh_yscalfctf |
coordinates | string | Name (for scaleFactor-Fgrid y-direction) used to replace the substring (FIELD) on the parametric URL name |
fileOceBCMesh_zscalfctt1d |
meshmask_vertical | string | Name (for scaleFactor-Tgrid-1d z-direction) used to replace the substring (FIELD) on the parametric URL name |
fileOceBCMesh_zscalfctw1d |
meshmask_vertical | string | Name (for scaleFactor-Wgrid-1d z-direction) used to replace the substring (FIELD) on the parametric URL name |
fileOceBCMesh_zscalfctu |
meshmask_e3u | string | Name (for scaleFactor-Ugrid-3d z-direction) used to replace the substring (FIELD) on the parametric URL name (needed if obc_lvelCorr=True) |
fileOceBCMesh_zscalfctv |
meshmask_e3v | string | Name (for scaleFactor-Vgrid-3d z-direction) used to replace the substring (FIELD) on the parametric URL name (needed if obc_lvelCorr=True) |
fileOceBCMesh_maskt |
mesh_tmask | string | Name (for LandSea-mask-Tgrid) used to replace the substring (FIELD) on the parametric URL name |
fileOceBCMesh_masku |
mesh_umask | string | Name (for LandSea-mask-Ugrid) used to replace the substring (FIELD) on the parametric URL name |
fileOceBCMesh_maskv |
mesh_vmask | string | Name (for LandSea-mask-Vgrid) used to replace the substring (FIELD) on the parametric URL name |
fileOceBCMesh_lkeepSrcFull |
True | bool | Enables if you want to keep the downloaded uncutted datasets |
set_dataDownlOceBCMesh_varName¶
This section outlines the parameters related to the variable names used within the Ocean Open Boundary Condition meshmask datasets. These variable names are crucial for accurately extracting and utilizing the data within the files.
| Parameter | Value | Type | Description |
|---|---|---|---|
srcDimOceBCMesh_lont |
x | string | Name of the dimension for the longitude |
srcDimOceBCMesh_lonu |
x | string | Name of the dimension for the longitude |
srcDimOceBCMesh_lonv |
x | string | Name of the dimension for the longitude |
srcDimOceBCMesh_lonw |
x | string | Name of the dimension for the longitude |
srcDimOceBCMesh_latt |
y | string | Name of the dimension for the latitude |
srcDimOceBCMesh_latu |
y | string | Name of the dimension for the latitude |
srcDimOceBCMesh_latv |
y | string | Name of the dimension for the latitude |
srcDimOceBCMesh_latw |
y | string | Name of the dimension for the latitude |
srcDimOceBCMesh_deptht |
z | string | Name of the dimension for the depth |
srcDimOceBCMesh_depthu |
z | string | Name of the dimension for the depth |
srcDimOceBCMesh_depthv |
z | string | Name of the dimension for the depth |
srcDimOceBCMesh_depthw |
z | string | Name of the dimension for the depth |
srcDimOceBCMesh_time |
t | string | Name of the dimension for the time |
srcCrdOceBCMesh_lont |
nav_lon | string | Name of the coordinate variable for the longitude coordinate |
srcCrdOceBCMesh_lonu |
nav_lon | string | Name of the coordinate variable for the longitude coordinate |
srcCrdOceBCMesh_lonv |
nav_lon | string | Name of the coordinate variable for the longitude coordinate |
srcCrdOceBCMesh_latt |
nav_lat | string | Name of the coordinate variable for the latitude coordinate |
srcCrdOceBCMesh_latu |
nav_lat | string | Name of the coordinate variable for the latitude coordinate |
srcCrdOceBCMesh_latv |
nav_lat | string | Name of the coordinate variable for the latitude coordinate |
srcCrdOceBCMesh_deptht |
nav_lev | string | Name of the coordinate variable for the depth coordinate |
srcCrdOceBCMesh_depthw |
nav_lev | string | Name of the coordinate variable for the depth coordinate |
srcCrdOceBCMesh_time |
nav_lev | string | Name of the coordinate variable for the time coordinate |
srcVarOceBCMesh_lont |
glamt | string | Name of the variable containing longitude coordinate |
srcVarOceBCMesh_lonu |
glamu | string | Name of the variable containing longitude coordinate |
srcVarOceBCMesh_lonv |
glamv | string | Name of the variable containing longitude coordinate |
srcVarOceBCMesh_lonf |
glamf | string | Name of the variable containing longitude coordinate |
srcVarOceBCMesh_latt |
gphit | string | Name of the variable containing latitude coordinate |
srcVarOceBCMesh_latu |
gphiu | string | Name of the variable containing latitude coordinate |
srcVarOceBCMesh_latv |
gphiv | string | Name of the variable containing latitude coordinate |
srcVarOceBCMesh_latf |
gphif | string | Name of the variable containing latitude coordinate |
srcVarOceBCMesh_deptht1d |
gdept_0 | string | Name of the variable containing depth coordinate |
srcVarOceBCMesh_depthw1d |
gdepw_0 | string | Name of the variable containing depth coordinate |
srcVarOceBCMesh_xscalfctt |
e1t | string | Name of the scale factors Tgrid in x-direction |
srcVarOceBCMesh_xscalfctu |
e1u | string | Name of the scale factors Ugrid in x-direction |
srcVarOceBCMesh_xscalfctv |
e1v | string | Name of the scale factors Vgrid in x-direction |
srcVarOceBCMesh_xscalfctf |
e1f | string | Name of the scale factors Fgrid in x-direction |
srcVarOceBCMesh_yscalfctt |
e2t | string | Name of the scale factors Tgrid in y-direction |
srcVarOceBCMesh_yscalfctu |
e2u | string | Name of the scale factors Ugrid in y-direction |
srcVarOceBCMesh_yscalfctv |
e2v | string | Name of the scale factors Vgrid in y-direction |
srcVarOceBCMesh_yscalfctf |
e2f | string | Name of the scale factors Fgrid in y-direction |
srcVarOceBCMesh_zscalfctt1d |
e3t_0 | string | Name of the scale factors Tgrid-1d in z-direction |
srcVarOceBCMesh_zscalfctw1d |
e3w_0 | string | Name of the scale factors Wgrid-1d in z-direction |
srcVarOceBCMesh_zscalfctu |
e3u | string | Name of the scale factors Ugrid-3d in z-direction (needed if obc_lvelCorr=True) |
srcVarOceBCMesh_zscalfctv |
e3v | string | Name of the scale factors Vgrid-3d in z-direction (needed if obc_lvelCorr=True) |
srcVarOceBCMesh_maskt |
tmask | string | Name of the land-sea-mask on T-points |
srcVarOceBCMesh_masku |
umask | string | Name of the land-sea-mask on U-points |
srcVarOceBCMesh_maskv |
vmask | string | Name of the land-sea-mask on V-points |
set_dataDownlOceBC_urlName_preSpinup¶
This section contains the parameters needed to build the URL for accessing pre-spinup Ocean Open Boundary Condition fields datasets. The datasets can be retrieved from either a local source or a remote repository.
| Parameter | Value | Type | Description |
|---|---|---|---|
urlOceBCPre_usr |
gofs | string | Username to access the datasets from a remote FTP server |
urlOceBCPre_pwd |
L##OOkkl!as | string | Password to access the datasets from a remote FTP server |
urlOceBCPre_urlbase |
file:///scratch/surf/indata_offline/ gulfTaranto_20141005/data/data00/ indata/ocean/oceanBC/srcFull | string | Parametric URL name for ocean input BC datasets with various parameters |
urlOceBCPre_temp |
tem | string | Name for Temperature used to replace the substring (FIELD) in the parametric URL name |
urlOceBCPre_sal |
sal | string | Name for Salinity used to replace the substring (FIELD) in the parametric URL name |
urlOceBCPre_ssh |
ssh | string | Name for Sea Surface Height used to replace the substring (FIELD) in the parametric URL name |
urlOceBCPre_velU |
cur | string | Name for Zonal Current used to replace the substring (FIELD) in the parametric URL name |
urlOceBCPre_velV |
cur | string | Name for Meridional Current used to replace the substring (FIELD) in the parametric URL name |
urlOceBCPre_tempGrid |
gridT | string | Name for Temperature grid used to replace the substring (GRID) in the parametric URL name |
urlOceBCPre_salGrid |
gridT | string | Name for Salinity grid used to replace the substring (GRID) in the parametric URL name |
urlOceBCPre_sshGrid |
gridT | string | Name for Sea Surface Height grid used to replace the substring (GRID) in the parametric URL name |
urlOceBCPre_velUGrid |
gridU | string | Name for Zonal Current grid used to replace the substring (GRID) in the parametric URL name |
urlOceBCPre_velVGrid |
gridV | string | Name for Meridional Current grid used to replace the substring (GRID) in the parametric URL name |
set_dataDownlOceBC_fileName_preSpinup¶
This section provides the parameters required to create the filenames for the pre-spinup Ocean Open Boundary Condition fields datasets. These filenames are used to locate and manage the specific datasets within your data storage system.
| Parameter | Value | Type | Description |
|---|---|---|---|
fileOceBCPre_lcompression |
False | bool | Enables if datasets you want to download are gzip compressed files (*.gz) |
fileOceBCPre_iProdDate |
1 | int | File Name format to be downloaded (=1):fixProdDate, (=2):varProdDate-DayofWeek |
fileOceBCPre_dateProdFixed |
20170801 | string | Datasets production date if iProdDate=1 is used in the URL/files |
fileOceBCPre_dateProdDayofWeek |
Wednesday | string | Datasets production day if iProdDate=2 is used in the URL/files |
fileOceBCPre_filebase |
EXP1_EAS1_1d_YYYY(i)MM(i)DD(i)_ YYYY(i+1)MM(i+1)DD(i+1)_(GRID)_IONIAN.nc | string | Parametric FILE name for ocean source input data with various parameters |
fileOceBCPre_temp |
_votemper | string | Name for Temperature used to replace the substring (FIELD) in the parametric file name |
fileOceBCPre_sal |
_vosaline | string | Name for Salinity used to replace the substring (FIELD) in the parametric file name |
fileOceBCPre_ssh |
2D | string | Name for Sea Surface Height used to replace the substring (FIELD) in the parametric file name |
fileOceBCPre_velU |
_vozocrtx | string | Name for Zonal Current used to replace the substring (FIELD) in the parametric file name |
fileOceBCPre_velV |
_vomecrty | string | Name for Meridional Current used to replace the substring (FIELD) in the parametric file name |
fileOceBCPre_tempGrid |
grid_T | string | Name for Temperature grid used to replace the substring (GRID) in the parametric file name |
fileOceBCPre_salGrid |
grid_T | string | Name for Salinity grid used to replace the substring (GRID) in the parametric file name |
fileOceBCPre_sshGrid |
grid_T | string | Name for Sea Surface Height grid used to replace the substring (GRID) in the parametric file name |
fileOceBCPre_velUGrid |
grid_U | string | Name for Zonal Current grid used to replace the substring (GRID) in the parametric file name |
fileOceBCPre_velVGrid |
grid_V | string | Name for Meridional Current grid used to replace the substring (GRID) in the parametric file name |
set_dataDownlOceBC_varName_preSpinup¶
This section details the parameters for specifying the field names of the pre-spinup Ocean Open Boundary Condition datasets. The field names identify the specific variables within the datasets, ensuring proper data extraction and processing.
| Parameter | Value | Type | Description |
|---|---|---|---|
srcDimOceBCPre_lont |
x | string | Name of the dimension for the longitude |
srcDimOceBCPre_lonu |
x | string | Name of the dimension for the longitude |
srcDimOceBCPre_lonv |
x | string | Name of the dimension for the longitude |
srcDimOceBCPre_lonw |
x | string | Name of the dimension for the longitude |
srcDimOceBCPre_latt |
y | string | Name of the dimension for the latitude |
srcDimOceBCPre_latu |
y | string | Name of the dimension for the latitude |
srcDimOceBCPre_latv |
y | string | Name of the dimension for the latitude |
srcDimOceBCPre_latw |
y | string | Name of the dimension for the latitude |
srcDimOceBCPre_deptht |
deptht | string | Name of the dimension for the depth |
srcDimOceBCPre_depthu |
depthu | string | Name of the dimension for the depth |
srcDimOceBCPre_depthv |
depthv | string | Name of the dimension for the depth |
srcDimOceBCPre_depthw |
depthw | string | Name of the dimension for the depth |
srcDimOceBCPre_time |
time_counter | string | Name of the dimension for the time |
srcCrdOceBCPre_lont |
nav_lon | string | Name of the coordinate variable for the longitude |
srcCrdOceBCPre_lonu |
nav_lon | string | Name of the coordinate variable for the longitude |
srcCrdOceBCPre_lonv |
nav_lon | string | Name of the coordinate variable for the longitude |
srcCrdOceBCPre_lonw |
nav_lon | string | Name of the coordinate variable for the longitude |
srcCrdOceBCPre_latt |
nav_lat | string | Name of the coordinate variable for the latitude |
srcCrdOceBCPre_latu |
nav_lat | string | Name of the coordinate variable for the latitude |
srcCrdOceBCPre_latv |
nav_lat | string | Name of the coordinate variable for the latitude |
srcCrdOceBCPre_latw |
nav_lat | string | Name of the coordinate variable for the latitude |
srcCrdOceBCPre_deptht |
deptht | string | Name of the coordinate variable for the depth |
srcCrdOceBCPre_depthu |
depthu | string | Name of the coordinate variable for the depth |
srcCrdOceBCPre_depthv |
depthv | string | Name of the coordinate variable for the depth |
srcCrdOceBCPre_depthw |
depthw | string | Name of the coordinate variable for the depth |
srcCrdOceBCPre_time |
time_counter | string | Name of the coordinate variable for the time |
srcVarOceBCPre_temp |
votemper | string | Name of the variable for the Temperature |
srcVarOceBCPre_sal |
vosaline | string | Name of the variable for the Salinity |
srcVarOceBCPre_ssh |
sossheig | string | Name of the variable for the Sea Surface Height |
srcVarOceBCPre_velU |
vozocrtx | string | Name of the variable for the Zonal Current |
srcVarOceBCPre_velV |
vomecrty | string | Name of the variable for the Merid Current |
set_dataDownlOceBC_urlName_postSpinup¶
This section contains the parameters needed to build the URL for accessing post-spinup Ocean Open Boundary Condition fields datasets. The datasets can be retrieved from either a local source or a remote repository.
| Parameter | Value | Type | Description |
|---|---|---|---|
urlOceBCPost_usr |
gofs | string | Username to access the datasets from a remote FTP server |
urlOceBCPost_pwd |
L##OOkkl!as | string | Password to access the datasets from a remote FTP server |
urlOceBCPost_urlbase |
file:///scratch/surf/indata_offline/ gulfTaranto_20141005/data/data00/ indata/ocean/oceanBC/srcFull | string | Parametric URL name for ocean input BC datasets with parameters for specific dates |
urlOceBCPost_temp |
tem | string | Name for Temperature used to replace the substring (FIELD) on the parametric URL name |
urlOceBCPost_sal |
sal | string | Name for Salinity used to replace the substring (FIELD) on the parametric URL name |
urlOceBCPost_ssh |
ssh | string | Name for Sea Surface Height used to replace the substring (FIELD) on the parametric URL name |
urlOceBCPost_velU |
cur | string | Name for Zonal Current used to replace the substring (FIELD) on the parametric URL name |
urlOceBCPost_velV |
cur | string | Name for Merid. Current used to replace the substring (FIELD) on the parametric URL name |
urlOceBCPost_tempGrid |
gridT | string | Name for Temperature used to replace the substring (GRID) on the parametric URL name |
urlOceBCPost_salGrid |
gridT | string | Name for Salinity used to replace the substring (GRID) on the parametric URL name |
urlOceBCPost_sshGrid |
gridT | string | Name for Sea Surface Height used to replace the substring (GRID) on the parametric URL name |
urlOceBCPost_velUGrid |
gridU | string | Name for Zonal Current used to replace the substring (GRID) on the parametric URL name |
urlOceBCPost_velVGrid |
gridV | string | Name for Merid. Current used to replace the substring (GRID) on the parametric URL name |
set_dataDownlOceBC_fileName_postSpinup¶
This section provides the parameters required to create the filenames for the post-spinup Ocean Open Boundary Condition fields datasets. These filenames are used to locate and manage the specific datasets within your data storage system.
| Parameter | Value | Type | Description |
|---|---|---|---|
fileOceBCPost_lcompression |
False | bool | Enables if datasets you want to download are gzip compressed files (*.gz) |
fileOceBCPost_iProdDate |
1 | int | File Name format to be downloaded (=1):fixProdDate, (=2):varProdDate-DayofWeek |
fileOceBCPost_dateProdFixed |
20170801 | string | Datasets production if iProdDate=1 is used in the URL/files |
fileOceBCPost_dateProdDayofWeek |
Wednesday | string | Datasets production if iProdDate=2 is used in the URL/files |
fileOceBCPost_filebase |
EXP1_EAS1_1d_YYYY(i)MM(i)DD(i)_ YYYY(i+1)MM(i+1)DD(i+1)_(GRID)_IONIAN.nc | string | Parametric FILE name for ocean source input data |
fileOceBCPost_temp |
_votemper | string | Name (for Temperature) used to replace the substring (FIELD) on the parametric file name |
fileOceBCPost_sal |
_vosaline | string | Name (for Salinity) used to replace the substring (FIELD) on the parametric file name |
fileOceBCPost_ssh |
2D | string | Name (for Sea Surface Height) used to replace the substring (FIELD) on the parametric file name |
fileOceBCPost_velU |
_vozocrtx | string | Name (for Merid. Current) used to replace the substring (FIELD) on the parametric file name |
fileOceBCPost_velV |
_vomecrty | string | Name (for Zonal Current) used to replace the substring (FIELD) on the parametric file name |
fileOceBCPost_tempGrid |
grid_T | string | Name (for Temperature) used to replace the substring (GRID) on the parametric file name |
fileOceBCPost_salGrid |
grid_T | string | Name (for Salinity) used to replace the substring (GRID) on the parametric file name |
fileOceBCPost_sshGrid |
grid_T | string | Name (for Sea Surface Height) used to replace the substring (GRID) on the parametric file name |
fileOceBCPost_velUGrid |
grid_U | string | Name (for Zonal Current) used to replace the substring (GRID) on the parametric file name |
fileOceBCPost_velVGrid |
grid_V | string | Name (for Merid. Current) used to replace the substring (GRID) on the parametric file name |
set_dataDownlOceBC_varName_postSpinup¶
This section details the parameters for specifying the field names of the post-spinup Ocean Open Boundary Condition datasets. The field names identify the specific variables within the datasets, ensuring proper data extraction and processing.
| Parameter | Value | Type | Description |
|---|---|---|---|
srcDimOceBCPost_lont |
x | string | Name of the dimension for the longitude |
srcDimOceBCPost_lonu |
x | string | Name of the dimension for the longitude |
srcDimOceBCPost_lonv |
x | string | Name of the dimension for the longitude |
srcDimOceBCPost_lonw |
x | string | Name of the dimension for the longitude |
srcDimOceBCPost_latt |
y | string | Name of the dimension for the latitude |
srcDimOceBCPost_latu |
y | string | Name of the dimension for the latitude |
srcDimOceBCPost_latv |
y | string | Name of the dimension for the latitude |
srcDimOceBCPost_latw |
y | string | Name of the dimension for the latitude |
srcDimOceBCPost_deptht |
deptht | string | Name of the dimension for the depth |
srcDimOceBCPost_depthu |
depthu | string | Name of the dimension for the depth |
srcDimOceBCPost_depthv |
depthv | string | Name of the dimension for the depth |
srcDimOceBCPost_depthw |
depthw | string | Name of the dimension for the depth |
srcDimOceBCPost_time |
time_counter | string | Name of the dimension for the time |
srcCrdOceBCPost_lont |
nav_lon | string | Name of the coordinate variable for the longitude |
srcCrdOceBCPost_lonu |
nav_lon | string | Name of the coordinate variable for the longitude |
srcCrdOceBCPost_lonv |
nav_lon | string | Name of the coordinate variable for the longitude |
srcCrdOceBCPost_lonw |
nav_lon | string | Name of the coordinate variable for the longitude |
srcCrdOceBCPost_latt |
nav_lat | string | Name of the coordinate variable for the latitude |
srcCrdOceBCPost_latu |
nav_lat | string | Name of the coordinate variable for the latitude |
srcCrdOceBCPost_latv |
nav_lat | string | Name of the coordinate variable for the latitude |
srcCrdOceBCPost_latw |
nav_lat | string | Name of the coordinate variable for the latitude |
srcCrdOceBCPost_deptht |
deptht | string | Name of the coordinate variable for the latitude |
srcCrdOceBCPost_depthu |
depthu | string | Name of the coordinate variable for the latitude |
srcCrdOceBCPost_depthv |
depthv | string | Name of the coordinate variable for the latitude |
srcCrdOceBCPost_depthw |
depthw | string | Name of the coordinate variable for the depth |
srcCrdOceBCPost_time |
time_counter | string | Name of the coordinate variable for the time |
srcVarOceBCPost_temp |
votemper | string | Name of the variable for the Temperature |
srcVarOceBCPost_sal |
vosaline | string | Name of the variable for the Salinity |
srcVarOceBCPost_ssh |
sossheig | string | Name of the variable for the Sea Surface Height |
srcVarOceBCPost_velU |
vozocrtx | string | Name of the variable for the Zonal Current |
srcVarOceBCPost_velV |
vomecrty | string | Name of the variable for the Merid Current |
Data Manipulation Settings¶
set_manipolBat¶
This section defines the parameters for modifying and controlling bathymetry values within the simulation domain.
| Parameter | Value | Type | Description |
|---|---|---|---|
manipBat_seaLevel |
0.0 | float | Value to be added to bathymetry to modify the surface elevation (e.g., Caspian Sea 28 meters) |
manipBat_minDepth |
5.0 | float | Minimum bathymetry value of the whole domain (at sea grid points) |
manipBat_maxDepth |
22000.0 | float | Maximum bathymetry value of the whole domain (at sea grid points) |
manipBat_lmoveDepth |
True | bool | Enables the modification of bathymetry (to a given value >= 0) inside rectangular regions |
manipBatMoveDepth_lonWest |
18.0 | float | Longitude of the western boundary of rectangular regions where you want to move the depth |
manipBatMoveDepth_lonEast |
18.375 | float | Longitude of the eastern boundary of rectangular regions where you want to move the depth |
manipBatMoveDepth_latSout |
40.3 | float | Latitude of the southern boundary of rectangular regions where you want to move the depth |
manipBatMoveDepth_latNort |
40.5625 | float | Latitude of the northern boundary of rectangular regions where you want to move the depth |
manipBatMoveDepth_depth |
0.0 | float | Depth of rectangular regions where you want to move the depth (if = 0.0, you add land points) |
set_shapFiltBat¶
This section defines the parameters for applying a Shapiro filter to the bathymetry data.
| Parameter | Value | Type | Description |
|---|---|---|---|
norder_shapFiltBat |
2 | int | Order of the Shapiro Filter for Bathy data |
nloop_shapFiltBat |
4 | int | Number of applications of the Shapiro Filter for Bathy data |
set_shapFiltOce¶
This section defines the parameters for applying a Shapiro filter to the output ocean data.
| Parameter | Value | Type | Description |
|---|---|---|---|
norder_shapFiltOce |
2 | int | Order of the Shapiro Filter for outOce data |
nloop_shapFiltOce |
10 | int | Number of applications of the Shapiro Filter for outOce data |
Interpolation Method Settings¶
set_interpMethodBat¶
This section specifies the interpolation method to be used when processing bathymetric elevation data.
| Parameter | Value | Type | Description |
|---|---|---|---|
interpMethodBat_elev |
bilin | string | Remapping option: bilin, bicub, distwgt |
set_interpMethodAtm¶
This section defines the interpolation methods used for remapping the atmospheric data fields required by the simulation.
| Parameter | Value | Type | Description |
|---|---|---|---|
interpMethodAtm_velU |
bilin | string | Remapping (sbc_iformulat=0,2) option: bilin, bicub, distwgt |
interpMethodAtm_velV |
bilin | string | Remapping (sbc_iformulat=0,2) option: bilin, bicub, distwgt |
interpMethodAtm_temp |
bilin | string | Remapping (sbc_iformulat=0,2) option: bilin, bicub, distwgt |
interpMethodAtm_dpTemp |
bilin | string | Remapping (sbc_iformulat=0) option: bilin, bicub, distwgt |
interpMethodAtm_mslp |
bilin | string | Remapping (sbc_iformulat=0 or/and sbc_aprdyn) option: bilin, bicub, distwgt |
interpMethodAtm_cloudCover |
bilin | string | Remapping (sbc_iformulat=0) option: bilin, bicub, distwgt |
interpMethodAtm_prec |
bilin | string | Remapping (sbc_iformulat=0,2) option: bilin, bicub, distwgt |
interpMethodAtm_tauU |
bilin | string | Remapping (sbc_iformulat=1) option: bilin, bicub, distwgt |
interpMethodAtm_tauV |
bilin | string | Remapping (sbc_iformulat=1) option: bilin, bicub, distwgt |
interpMethodAtm_qtot |
bilin | string | Remapping (sbc_iformulat=1) option: bilin, bicub, distwgt |
interpMethodAtm_qsr |
bilin | string | Remapping (sbc_iformulat=1) option: bilin, bicub, distwgt |
interpMethodAtm_emp |
bilin | string | Remapping (sbc_iformulat=1) option: bilin, bicub, distwgt |
interpMethodAtm_tempS |
bilin | string | Remapping (sbc_iformulat=1) option: bilin, bicub, distwgt |
interpMethodAtm_salS |
bilin | string | Remapping (sbc_iformulat=1) option: bilin, bicub, distwgt |
interpMethodAtm_umid |
bilin | string | Remapping (sbc_iformulat=2) option: bilin, bicub, distwgt |
interpMethodAtm_radLW |
bilin | string | Remapping (sbc_iformulat=2) option: bilin, bicub, distwgt |
interpMethodAtm_radSW |
bilin | string | Remapping (sbc_iformulat=2) option: bilin, bicub, distwgt |
interpMethodAtm_snow |
bilin | string | Remapping (sbc_iformulat=2) option: bilin, bicub, distwgt |
set_interpMethodOceIC¶
This section defines the interpolation methods used for remapping the ocean initial condition data fields necessary for the simulation.
| Parameter | Value | Type | Description |
|---|---|---|---|
interpMethodOceIC_temp |
bilin | string | Remapping option: bilin, bicub, distwgt |
interpMethodOceIC_sal |
bilin | string | Remapping option: bilin, bicub, distwgt |
interpMethodOceIC_ssh |
bilin | string | Remapping option: bilin, bicub, distwgt |
interpMethodOceIC_velU |
bilin | string | Remapping option: bilin, bicub, distwgt |
interpMethodOceIC_velV |
bilin | string | Remapping option: bilin, bicub, distwgt |
set_interpMethodOceBC¶
This section defines the interpolation methods used for remapping the ocean boundary condition data fields required by the simulation.
| Parameter | Value | Type | Description |
|---|---|---|---|
interpMethodOceBC_temp |
bilin | string | Remapping option: bilin, bicub, distwgt |
interpMethodOceBC_sal |
bilin | string | Remapping option: bilin, bicub, distwgt |
interpMethodOceBC_ssh |
bilin | string | Remapping option: bilin, bicub, distwgt |
interpMethodOceBC_velU |
bilin | string | Remapping option: bilin, bicub, distwgt |
interpMethodOceBC_velV |
bilin | string | Remapping option: bilin, bicub, distwgt |
Output Management Settings¶
set_lvarOceOutT¶
This section defines the settings for controlling which oceanographic fields (on the T-grid) are written to the output files at the end of the simulation.
| Parameter | Value | Type | Description |
|---|---|---|---|
lvarOceOutT_temp |
True | bool | Enables if you want to write Temperature (votemper) field in the output file |
lvarOceOutT_sal |
True | bool | Enables if you want to write Salinity (vosaline) field in the output file |
lvarOceOutT_tempS |
False | bool | Enables if you want to write Surface temperature (sosstsst) field in the output file |
lvarOceOutT_salS |
False | bool | Enables if you want to write Surface Salinity (sosaline) field in the output file |
lvarOceOutT_ssh |
True | bool | Enables if you want to write Sea Surface Height (sossheig) field in the output file |
lvarOceOutT_fluxWater_up |
False | bool | Enables if you want to write Net Upward Water Flux (sowaflup) field in the output file |
lvarOceOutT_fluxSalt_down |
False | bool | Enables if you want to write downward salt flux (sosfldow) field in the output file |
lvarOceOutT_fluxHeat_down |
False | bool | Enables if you want to write Net Downward Heat Flux (sohefldo) field in the output file |
lvarOceOutT_fluxHeatS_damp |
False | bool | Enables if you want to write Surface Heat Flux: Damping (sohefldp) field in the output file |
lvarOceOutT_fluxWaterS_damp |
False | bool | Enables if you want to write Surface Water Flux: Damping (sowafldp) field in the output file |
lvarOceOutT_fluxSaltS_damp |
False | bool | Enables if you want to write Surface salt flux: damping (sosafldp) field in the output file |
lvarOceOutT_runoffs |
False | bool | Enables if you want to write River runoffs (sorunoff) field in the output file |
lvarOceOutT_tempConcen |
False | bool | Enables if you want to write Concentration/Dilution term on temperature (sosst_cd) field in the output file |
lvarOceOutT_salConcen |
False | bool | Enables if you want to write Concentration/Dilution term on salinity (sosss_cd) field in the output file |
lvarOceOutT_radSW |
False | bool | Enables if you want to write Shortwave Radiation (soshfldo) field in the output file |
lvarOceOutT_depthTurb |
False | bool | Enables if you want to write Turbocline Depth (somixhgt) field in the output file |
lvarOceOutT_mld |
True | bool | Enables if you want to write Mixed Layer Depth 0.01 (somxl010) field in the output file |
lvarOceOutT_iceFrac |
False | bool | Enables if you want to write Ice fraction (soicecov) field in the output file |
lvarOceOutT_wind10 |
False | bool | Enables if you want to write wind speed at 10m (sowindsp) field in the output file |
lvarOceOutT_bowlin |
False | bool | Enables if you want to write Bowl Index (sobowlin) field in the output file |
set_lvarOceOutU¶
This section defines the settings for controlling which oceanographic fields (on the U-grid) are written to the output files at the end of the simulation.
| Parameter | Value | Type | Description |
|---|---|---|---|
lvarOceOutU_velU |
True | bool | Enables if you want to write Zonal Current (vozocrtx) field in the output file |
lvarOceOutU_tauU |
True | bool | Enables if you want to write Zonal Wind Stress (sozotaux) field in the output file |
set_lvarOceOutV¶
This section defines the settings for controlling which oceanographic fields (on the V-grid) are written to the output files at the end of the simulation.
| Parameter | Value | Type | Description |
|---|---|---|---|
lvarOceOutV_velV |
True | bool | Enables if you want to write Meridional Current (vomecrty) field in the output file |
lvarOceOutV_tauV |
True | bool | Enables if you want to write Meridional Wind Stress (sometauy) field in the output file |
set_lvarOceOutW¶
This section defines the settings for controlling which oceanographic fields (on the W-grid) are written to the output files at the end of the simulation.
| Parameter | Value | Type | Description |
|---|---|---|---|
lvarOceOutW_velW |
False | bool | Enables if you want to write Vertical Velocity (vovecrtz) field in the output file |
lvarOceOutW_eddyDiffW |
False | bool | Enables if you want to write Vertical Eddy Diffusivity (votkeavt) field in the output file |
lvarOceOutW_eddyViscW |
False | bool | Enables if you want to write Vertical Eddy Viscosity (votkeavm) field in the output file |