Skip to content

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, A002 for pre-processing sections, and B001, B002 for 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.

../assets/img/jsonFile.png
Figure 5.1. JSON representation for the SURF-NEMO user-configuration file.

General Configuration and Initialization

set_surf

This section contains the following two parameters:

Parameter Value Description
nnest 1 Number of nesting domains
nameNestDomain gulfTaranto 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 Description
lrun_childMeshMask True Enables the execution of the CHILD-MESHMASK GENERATION task
lrun_regridPreAtm True Enables the execution of the ATMOSPHERIC-DATA-REGRIDDING task
lrun_regridPreOceIC True Enables the execution of the OCEAN-IC-DATA-REGRIDDING phase
lrun_regridPreOceBC True Enables the execution of the OCEAN-BC-DATA-REGRIDDING phase
lrun_regridPreTideBC False Enables the execution of the TIDE-BC-DATA-REGRIDDING phase
lrun_regridPreWeights True Enables the computation/copy of WEIGHT-FILEs for input fields remapping
lrun_ocean True Enables the execution of the NEMO code
lrun_regridOutUV False Enables the execution of the output-UV fields remapping (from UV GRID to T-GRID)
lrun_regridOutUVWeghts False Enables the computation/copy of WEIGHT-FILEs for output-UV fields remapping
lrun_shapFiltBat True Enables the execution of the SHAPIRO Filter for Bathymetric datasets
lrun_shapFiltOce False Enables the execution of the SHAPIRO Filter for Ocean datasets

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 Description
gr_xygridSpec 0 Parameters specification for the horizontal grid
gr_jpidta 94 Number of grid points in the zonal direction
gr_jpjdta 79 Number of grid points in the meridional direction
gr_ppglam0 16.4375 Longitude of the first raw and column T-point
gr_ppglam1 NOTUSED Longitude of the last raw and column T-point (if applicable)
gr_ppgphi0 38.9375 Latitude of the first raw and column T-point
gr_ppgphi1 NOTUSED Latitude of the last raw and column T-point (if applicable)
gr_jp_cfg 48.0 Child model resolution (1/gr_jp_cfg)
gr_jp_cfg_father 16.0 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 Description
gr_jpkdta 120 Number of vertical levels
gr_zgridSpec 1 Parameters specification for the vertical grid
gr_ppsur NOTUSED Parameter h_sur for the z-coord. transformation (if applicable)
gr_ppa0 NOTUSED Parameter h_0 for the z-coordinate transformation (if applicable)
gr_ppa1 NOTUSED Parameter h_1 for the z-coordinate transformation (if applicable)
gr_ppkth 100.0 Parameter h_th for layer stretching in the vertical grid
gr_ppacr 30.0 Grid stretching factor
gr_ppdzminw 2.8 Depth of the top model layer
gr_pphmaxw 0.0 Maximum depth of the ocean depth
gr_dbletanh False Enables the use of the double tanh function for vertical coordinates
gr_ppa2 NOTUSED Parameter h_2 if double tanh is enabled (if applicable)
gr_ppkth2 NOTUSED Parameter h_th2 if double tanh is enabled (if applicable)
gr_ppacr2 NOTUSED Parameter h_cr2 if double tanh is enabled (if applicable)
---

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 Description
start_date 20141005 Initial date of the simulation (the run starts at 00:00)
ndays 3 Total number of simulation days
ndays_spinup 1 Number of spin-up days
dom_rdt 150.0 Simulation 'baroclinic' time step
runMan_write 24 Frequency of write in the output file expressed as the number of simulation time steps
dom_btAuto False Enables the automatic definition of baro-timestep based on maximum courant number
dom_btCmax 0.8 Maximum courant number (allowed if dom_btAuto=True)
dom_baro 100 Number of iterations of barotropic mode during dom_rdt (allowed if dom_btAuto=False)
runMan_rstart True Start from rest (False) or from a restart file (True)
ndays_xsimu 1.0 Number of days per each restart simulation

Boundary and Surface Condition Settings

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 Description
latBtide_lPot False Enables the use of tidal potential forcing
latBtide_K1 K1 Name of the Lunar diurnal K1 tidal component
latBtide_O1 O1 Name of the Lunar diurnal O1 tidal component
latBtide_P1 P1 Name of the Solar diurnal P1 tidal component
latBtide_Q1 Q1 Name of the Larger lunar elliptic diurnal Q1 tidal component
latBtide_K2 K2 Name of the Lunisolar semidiurnal K2 tidal component
latBtide_M2 M2 Name of the Principal lunar semidiurnal M2 tidal component
latBtide_N2 N2 Name of the Larger lunar elliptic semidiurnal N2 tidal component
latBtide_S2 S2 Name of the Principal solar semidiurnal S2 tidal component
latBtide_M4 M4 Name of the Shallow water overtides of principal lunar M4 tidal component
latBtide_Mm NOTUSED Name of the Lunar monthly Mm tidal component
latBtide_Mf NOTUSED Name of the Lunisolar fortnightly Mf tidal component

set_sbc

This section contains the parameters used to set up surface boundary conditions.

Parameter Value Description
sbc_iformulat 0 Surface boundary condition formulation to be used: 0 = MFS bulk formulat, 1 = fluxform+ssRest, 2 = CORE formulation
sbc_ltimeInterp True Activate or not the time interpolation: False = steplike shape forcing, True = broken line shape forcing
sbc_zreftemp 10.0 Reference height (m) for the Air Temperature and humidity (for the CORE formulation)
sbc_zrefwind 10.0 Reference height (m) for the wind vector (for the CORE formulation)
sbc_aprdyn False Enables the inclusion of atmospheric pressure gradient in ocean and ice equations
sbc_sclapr 1.0 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 Description
obc_dyn2d flather Algorithm of boundary condition for barotropic solution: flather
obc_dyn2d_dta 1 Boundary data to use: 0 = Initial condition, 1 = external data, 2 = tidal forcing, 3 = external data+tidal
obc_dyn3d frs Algorithm of boundary condition for baroclinic velocities: frs, orlanski
obc_dyn3d_dta 1 Boundary data to use: 0 = Initial condition, 1 = external data
obc_tra frs Algorithm of boundary condition for active tracers: frs, orlanski
obc_tra_dta 1 Boundary data to use: 0 = Initial condition, 1 = external data
obc_rimwidth 1 Width of the FRS zone
obc_ltimeInterp True Activate or not the time interpolation: False = steplike shape forcing, True = broken line shape forcing
obc_lvelCorr True Activate the Integral Constraint method to preserve the total transport after the interpolation

Physical Parameterization Settings

set_eos

This section defines the parameters related to the equation of state of seawater.

Parameter Value Description
eos_type 0 Type of equation of state and Brunt-Vaisala frequency: -1 = TEOS-10, 0 = EOS-80, 1 = S-EOS
eos_useCT False Enables the use of Conservative Temperature; surface CT converted to Potential Temperature in sbcssm
eos_a0 0.1655 S-EOS coefficients: thermal expansion coefficient
eos_b0 0.76554 S-EOS coefficients: saline expansion coefficient
eos_lambda1 0.05952 S-EOS coefficients: cabbeling coefficient in T² (0 for linear EOS)
eos_lambda2 0.00074914 S-EOS coefficients: cabbeling coefficient in S² (0 for linear EOS)
eos_mu1 0.0001497 S-EOS coefficients: thermobaric coefficient in T (0 for linear EOS)
eos_mu2 1.109e-05 S-EOS coefficients: thermobaric coefficient in S (0 for linear EOS)
eos_nu 0.0024341 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 Description
botB_bfri2 1.e-3 Bottom drag coefficient (non-linear case)
botB_bfeb2 2.5e-3 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 Description
tra_typeOperator 1 Type of operator used: 0 = laplacian, 1 = bilaplacian
tra_eddycoeffSpec 1 Horizontal eddy coefficient specification: 0 = defined by tra_eddycoeff_child, 1 = defined from tra_eddycoeff_father
tra_eddycoeff_child -6.e8 Horizontal eddy diffusivity of the child model (>0 for laplacian, <0 for bilaplacian) (if =NOTUSED, parameter not read)
tra_eddycoeff_father -6.e8 Horizontal eddy diffusivity of the father model to be used in fat/child coefficient relation (if =NOTUSED, parameter not read)
tra_factor 1.0 Factor used in fat/child coefficient relation (for laplacian or bilaplacian calculations)

set_xyturbMomentum

This section includes the free input parameters that define the parameterization of lateral subgrid-scale viscosity for momentum.

Parameter Value Description
dyn_typeOperator 1 Type of operator used: 0 = laplacian, 1 = bilaplacian
dyn_eddycoeffSpec 1 Horizontal eddy coefficient specification: 0 = defined by dyn_eddycoeff_child, 1 = defined from dyn_eddycoeff_father
dyn_eddycoeff_child -0.5e9 Horizontal eddy viscosity of the child model (>0 for laplacian, <0 for bilaplacian) (if =NOTUSED, parameter not read)
dyn_eddycoeff_father -1.e9 Horizontal eddy viscosity of the father model to be used in father/child coefficient relation (if =NOTUSED, parameter not read)
dyn_factor 1.0 Factor used in father/child coefficient relation (for laplacian or bilaplacian calculations)

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 Description
zdyn_avm0 1.2e-5 Vertical eddy viscosity [m²/s] (background Kz if not 'key_zdfcst')
zdyn_avt0 1.2e-6 Vertical eddy diffusivity [m²/s] (background Kz if not 'key_zdfcst')
zdyn_avevd 10.0 EVD mixing coefficient [m²/s]
zdynric_avmri 1.e-2 Maximum value of the vertical viscosity
zdynric_alp 5.0 ...
zdynric_ric 2 ...
zdynric_ekmfc 0.7 ...
zdynric_mldmin 1.0 ...
zdynric_mldmax 1000.0 ...
zdynric_wtmix 10.0 ...
zdynric_wvmix 10.0 ...
zdynric_mldw False ...
zdyntke_ediff 0.1 ...
zdyntke_ediss 0.7 ...
zdyntke_ebb 67.83 ...
zdyntke_emin 1.e-6 ...
zdyntke_emin0 1.e-4 ...
zdyntke_mxl 2 ...
zdyntke_pdl 1 ...
zdyntke_lmxl0 True ...
zdyntke_rmxl0 0.04 ...
zdyntke_llc True ...
zdyntke_rlc 0.15 ...
zdyntke_etau 0 ...
zdyntke_efr 0.05 ...
zdyntke_htau 1 ...
zdyngls_emin 1.e-6 ...
zdyngls_epsmin 1.e-12 ...
zdyngls_length_lim True ...
zdyngls_clim_galp 0.53 ...
zdyngls_sigpsi True ...
zdyngls_rcrban 100.0 ...
zdyngls_charn 70000.0 ...
zdyngls_hsro 0.02 ...
zdyngls_frac_hs 1.3 ...
zdyngls_z0_met 2 ...
zdyngls_bc_surf 1 ...
zdyngls_bc_bot 1 ...
zdyngls_stab_func 2 ...
zdyngls_clos 1 ...
zdynkpp_kpprimix True ...
zdynkpp_difmiw 1.0e-04 ...
zdynkpp_difsiw 0.1e-04 ...
zdynkpp_riinfty 0.8 ...
zdynkpp_difri 0.0050 ...
zdynkpp_bvsqcon -0.01e-07 ...
zdynkpp_difcon 1.0 ...
zdynkpp_avb_k 0 ...
zdynkpp_ave 1 ...

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 Description
urlCoast_usr myusername Username to access the coastline datasets from a remote FTP server
urlCoast_pwd mypwd Password to access the coastline datasets from a remote FTP server
urlCoast_urlbase file:///scratch/surf/surf_datasets/current/coastline/GSHHS_shp/(RESCOAST) Parametric URL name (e.g., ftp:/... or file:///...) for the coastline datasets. Parameters: (RESCOAST)
urlCoast_resol h Name for spatial resolution used to replace the substring (RESCOAST) in the parametric URL name

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 Description
fileCoast_lland True Enables the use of the land coastline
fileCoast_filebaseLand GSHHS_(RESCOAST)_L1.shp File name for NOAA coastline datasets containing the boundary between land and ocean (if fileCoast_lland=True)
fileCoast_llake False Enables the use of the lake coastline
fileCoast_filebaseLake GSHHS_(RESCOAST)_L2.shp File name for NOAA coastline datasets containing the boundary between lake and land (if fileCoast_llake=True)
fileCoast_lislandlake False Enables the use of the islelake coastline
fileCoast_filebaseIslandlake GSHHS_(RESCOAST)_L3.shp File name for NOAA coastline datasets containing the boundary between island-in-lake and lake (if fileCoast_lislandlake=True)
fileCoast_resol h Name for spatial resolution used to replace the substring (RESCOAST) in the parametric file name
fileCoast_lcompression False Indicates if datasets to be downloaded are gzip compressed files (*.gz)
fileCoast_lkeepSrcFull True Indicates if the full uncut datasets should be kept on disk after download

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 Description
urlBat_usr myusername Username to access the bathymetric datasets from a remote FTP server
urlBat_pwd mypwd Password to access the bathymetric datasets from a remote FTP server
urlBat_urlbase file:///scratch/surf/surf_datasets/current/bathymetry Parametric URL name (e.g., ftp:/... or file:///...) for the bathymetric datasets
urlBat_resol h Name for spatial resolution used to replace the substring (RESOL) in the parametric URL name

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 Description
fileBat_filebase GEBCO_2014_2D.nc Parametric filename for the source bathymetric datasets
fileBat_resol NOTUSED Name for spatial resolution used to replace the substring (RESBAT) in the parametric file name
fileBat_lcompression False Indicates if the dataset to download is in gzip compressed files (*.gz)
fileBat_llonFlip False Indicates if longitude coordinates are in the 0 to 360 range (True) or -180 to +180 range (False)
fileBat_llatInv False Indicates if the dataset contains latitude decreasing through the pole
fileBat_ldepthIncr False Indicates if the dataset contains sea floor elevation (positive) that increases with increasing water depth
fileBat_lkeepSrcFull False Indicates if the full uncut datasets should be kept on disk after download

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 Description
srcDimBat_lon lon Name of the dimension for the longitude
srcDimBat_lat lat Name of the dimension for the latitude
srcCrdBat_lon lon Name of the coordinate variable for the longitude
srcCrdBat_lat lat Name of the coordinate variable for the latitude
srcVarBat_elev elevation Name of the variable for the Sea Floor Elevation
---

set_dataDownlTideMesh_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 Description
urlTideMesh_usr myusername Username to access the input tidal forcing meshmask datasets from a remote FTP server
urlTideMesh_pwd mypwd Password to access the input tidal forcing meshmask datasets from a remote FTP server
urlTideMesh_urlbase file:///scratch/surf/surf_datasets/current/tide/TPXO8_atlas_30_v1_nc Parametric URL name (e.g., ftp:/... or file:///...) for the input tidal forcing meshmask datasets
urlTideMesh_K1 NOTUSED Name for tidal constituent K1 used to replace the substring (FIELD) on the parametric URL name
urlTideMesh_O1 NOTUSED Name for tidal constituent O1 used to replace the substring (FIELD) on the parametric URL name
urlTideMesh_P1 NOTUSED Name for tidal constituent P1 used to replace the substring (FIELD) on the parametric URL name
urlTideMesh_Q1 NOTUSED Name for tidal constituent Q1 used to replace the substring (FIELD) on the parametric URL name
urlTideMesh_K2 NOTUSED Name for tidal constituent K2 used to replace the substring (FIELD) on the parametric URL name
urlTideMesh_M2 NOTUSED Name for tidal constituent M2 used to replace the substring (FIELD) on the parametric URL name
urlTideMesh_N2 NOTUSED Name for tidal constituent N2 used to replace the substring (FIELD) on the parametric URL name
urlTideMesh_S2 NOTUSED Name for tidal constituent S2 used to replace the substring (FIELD) on the parametric URL name
urlTideMesh_M4 NOTUSED Name for tidal constituent M4 used to replace the substring (FIELD) on the parametric URL name
urlTideMesh_Mm NOTUSED Name for tidal constituent Mm used to replace the substring (FIELD) on the parametric URL name
urlTideMesh_Mf NOTUSED Name for tidal constituent Mf used to replace the substring (FIELD) on the parametric URL name

set_dataDownlTideMesh_fileName

This section specifies the parameters required to generate the filenames of the tidal meshmask datasets. These filenames help identify the relevant files in the storage location.

Parameter Value Description
fileTideMesh_filebase_bathy grid_tpxo8(CONS).nc Parametric filename for the Zonal Air Velocity datasets before the spinup-time
fileTideMesh_K1 atlas_30_v1 Name for tidal constituent K1 used to replace the substring (CONS) in the filename
fileTideMesh_O1 atlas_30_v1 Name for tidal constituent O1 used to replace the substring (CONS) in the filename
fileTideMesh_P1 atlas_30_v1 Name for tidal constituent P1 used to replace the substring (CONS) in the filename
fileTideMesh_Q1 atlas_30_v1 Name for tidal constituent Q1 used to replace the substring (CONS) in the filename
fileTideMesh_K2 atlas_30_v1 Name for tidal constituent K2 used to replace the substring (CONS) in the filename
fileTideMesh_M2 atlas_30_v1 Name for tidal constituent M2 used to replace the substring (CONS) in the filename
fileTideMesh_N2 atlas_30_v1 Name for tidal constituent N2 used to replace the substring (CONS) in the filename
fileTideMesh_S2 atlas_30_v1 Name for tidal constituent S2 used to replace the substring (CONS) in the filename
fileTideMesh_M4 atlas_30_v1 Name for tidal constituent M4 used to replace the substring (CONS) in the filename
fileTideMesh_Mm NOTUSED Name for tidal constituent Mm used to replace the substring (CONS) in the filename
fileTideMesh_Mf NOTUSED Name for tidal constituent Mf used to replace the substring (CONS) in the filename
fileTideMesh_lcompression False Indicates if the datasets you want to download are gzip compressed files (*.gz)
fileTideMesh_llonFlip True Indicates if longitude coordinates are in the 0 to 360 range (True) or -180 to +180 range (False)
fileTideMesh_llatInv False Indicates if the dataset contains latitude decreasing through the pole
fileTideMesh_lkeepSrcFull True Indicates if the full uncut datasets should be kept on disk after download

set_dataDownlTideMesh_varName

This section outlines the parameters related to the variable names used within the tidal meshmask datasets. These variable names are crucial for accurately extracting and utilizing the data within the files.

Parameter Value Description
srcDimTideMesh_lont nx Name of the dimension for the longitude of T-points
srcDimTideMesh_lonu nx Name of the dimension for the longitude of U-points
srcDimTideMesh_lonv nx Name of the dimension for the longitude of V-points
srcDimTideMesh_latt ny Name of the dimension for the latitude of T-points
srcDimTideMesh_latu ny Name of the dimension for the latitude of U-points
srcDimTideMesh_latv ny Name of the dimension for the latitude of V-points
srcCrdTideMesh_lont lon_z Name of the variable containing longitude coordinate of T-points
srcCrdTideMesh_lonu lon_u Name of the variable containing longitude coordinate of U-points
srcCrdTideMesh_lonv lon_v Name of the variable containing longitude coordinate of V-points
srcCrdTideMesh_latt lat_z Name of the variable containing latitude coordinate of T-points
srcCrdTideMesh_latu lat_u Name of the variable containing latitude coordinate of U-points
srcCrdTideMesh_latv lat_v Name of the variable containing latitude coordinate of V-points
srcVarTideMesh_batt hz Name of the variable containing the Land Sea Mask of T-points
srcVarTideMesh_batu hu Name of the variable containing the Land Sea Mask of U-points
srcVarTideMesh_batv hv Name of the variable containing the Land Sea Mask of V-points

set_dataDownlTide_urlName

This section contains the parameters needed to build the URL for accessing tidal fields datasets. The datasets can be retrieved from either a local source or a remote repository.

Parameter Value Description
urlTide_usr myusername Username to access the barotropic tide datasets from a remote server
urlTide_pwd mypwd Password to access the barotropic tide datasets from a remote server
urlTide_urlbase file:///scratch/surf/surf_datasets/current/tide/TPXO8_atlas_30_v1_nc Base URL for the barotropic tide datasets. Parameters: (CONS)
urlTide_K1 NOTUSED Name for tidal constituent K1 used to replace the substring (CONS)
urlTide_O1 NOTUSED Name for tidal constituent O1 used to replace the substring (CONS)
urlTide_P1 NOTUSED Name for tidal constituent P1 used to replace the substring (CONS)
urlTide_Q1 NOTUSED Name for tidal constituent Q1 used to replace the substring (CONS)
urlTide_K2 NOTUSED Name for tidal constituent K2 used to replace the substring (CONS)
urlTide_M2 NOTUSED Name for tidal constituent M2 used to replace the substring (CONS)
urlTide_N2 NOTUSED Name for tidal constituent N2 used to replace the substring (CONS)
urlTide_S2 NOTUSED Name for tidal constituent S2 used to replace the substring (CONS)
urlTide_M4 NOTUSED Name for tidal constituent M4 used to replace the substring (CONS)
urlTide_Mm NOTUSED Name for tidal constituent Mm used to replace the substring (CONS)
urlTide_Mf NOTUSED Name for tidal constituent Mf used to replace the substring (CONS)
---

set_dataDownlTide_fileName

This section provides the parameters required to create the filenames for the tidal fields datasets. These filenames are used to locate and manage the specific datasets within your data storage system.

Parameter Value Description
fileTide_filebase_elev hf.(CONS)_tpxo8_atlas_30c_v1.nc Filename for Tidal elevation datasets
fileTide_filebase_velU uv.(CONS)_tpxo8_atlas_30c_v1.nc Filename for Tidal WE transport datasets
fileTide_filebase_velV uv.(CONS)_tpxo8_atlas_30c_v1.nc Filename for Tidal SN transport datasets
fileTide_K1 k1 Tidal constituent K1 to replace the substring (CONS)
fileTide_O1 o1 Tidal constituent O1 to replace the substring (CONS)
fileTide_P1 p1 Tidal constituent P1 to replace the substring (CONS)
fileTide_Q1 q1 Tidal constituent Q1 to replace the substring (CONS)
fileTide_K2 k2 Tidal constituent K2 to replace the substring (CONS)
fileTide_M2 m2 Tidal constituent M2 to replace the substring (CONS)
fileTide_N2 n2 Tidal constituent N2 to replace the substring (CONS)
fileTide_S2 s2 Tidal constituent S2 to replace the substring (CONS)
fileTide_M4 m4 Tidal constituent M4 to replace the substring (CONS)
fileTide_Mm NOTUSED Tidal constituent Mm not used
fileTide_Mf NOTUSED Tidal constituent Mf not used
fileTide_lcompression False Indicates if datasets are gzip compressed files (*.gz)

set_dataDownlTide_varName

This section details the parameters for specifying the field names of the tidal datasets. The field names identify the specific variables within the datasets, ensuring proper data extraction and processing.

Parameter Value Description
srcDimTide_lont nx Name of the dimension for the longitude of T-points
srcDimTide_lonu nx Name of the dimension for the longitude of U-points
srcDimTide_lonv nx Name of the dimension for the longitude of V-points
srcDimTide_latt ny Name of the dimension for the latitude of T-points
srcDimTide_latu ny Name of the dimension for the latitude of U-points
srcDimTide_latv ny Name of the dimension for the latitude of V-points
srcCrdTide_lont lon_z Name of the coordinate variable for the longitude of T-points
srcCrdTide_lonu lon_u Name of the coordinate variable for the longitude of U-points
srcCrdTide_lonv lon_v Name of the coordinate variable for the longitude of V-points
srcCrdTide_latt lat_z Name of the coordinate variable for the latitude of T-points
srcCrdTide_latu lat_u Name of the coordinate variable for the latitude of U-points
srcCrdTide_latv lat_v Name of the coordinate variable for the latitude of V-points
srcVarTide_elevIm hIm Name of the variable for the Tidal elevation complex amplitude (Imag part) of the Lunar diurnal K1 tidal component datasets
srcVarTide_elevRe hRe Name of the variable for the Tidal elevation complex amplitude (Real part) of the Lunar diurnal K1 tidal component datasets
srcVarTide_velUIm uIm Name of the variable for the Tidal WE transport complex amplitude (Imag part) of the Lunar diurnal K1 tidal component datasets
srcVarTide_velURe uRe Name of the variable for the Tidal WE transport complex amplitude (Real part) of the Lunar diurnal K1 tidal component datasets
srcVarTide_velVIm vIm Name of the variable for the Tidal SN transport complex amplitude (Imag part) of the Lunar diurnal K1 tidal component datasets
srcVarTide_velVRe vRe Name of the variable for the Tidal SN transport complex amplitude (Real part) of the Lunar diurnal K1 tidal component datasets

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 Description
urlAtmMesh_usr myusername Username to access the input atmospheric meshmask datasets from a remote FTP server
urlAtmMesh_pwd mypwd Password to access the input atmospheric meshmask datasets from a remote FTP server
urlAtmMesh_urlbase file:///scratch/surf/indata_offline/gulfTaranto_20141005/data/data00/indata/atmosphere/srcFull Parametric URL for the input atmospheric meshmask datasets. Parameters: (FIELD), YYYY(p)MM(p)DD(p)
urlAtmMesh_velU NOTUSED Name for the Zonal Air Velocity used to replace the substring (FIELD) on the parametric URL name
urlAtmMesh_velV NOTUSED Name for the Meridional Air Velocity used to replace the substring (FIELD) on the parametric URL name
urlAtmMesh_mslp NOTUSED Name for the Mean Sea-Level Pressure used to replace the substring (FIELD) on the parametric URL name
urlAtmMesh_cloudCov NOTUSED Name for the Total Cloud Cover used to replace the substring (FIELD) on the parametric URL name
urlAtmMesh_temp NOTUSED Name for the Air Temperature used to replace the substring (FIELD) on the parametric URL name
urlAtmMesh_dpTemp NOTUSED Name for the Dewpoint Temperature used to replace the substring (FIELD) on the parametric URL name
urlAtmMesh_prec NOTUSED Name for the Total Precipitation used to replace the substring (FIELD) on the parametric URL name
urlAtmMesh_tauU NOTUSED Name for the Zonal Wind Stress used to replace the substring (FIELD) on the parametric URL name
urlAtmMesh_tauV NOTUSED Name for the Meridional Wind Stress used to replace the substring (FIELD) on the parametric URL name
urlAtmMesh_qtot NOTUSED Name for the Total Heat Flux used to replace the substring (FIELD) on the parametric URL name
urlAtmMesh_qsr NOTUSED Name for the Solar Radiation Penetration used to replace the substring (FIELD) on the parametric URL name
urlAtmMesh_emp NOTUSED Name for the Mass Flux Exchanged used to replace the substring (FIELD) on the parametric URL name
urlAtmMesh_tempS NOTUSED Name for the Surface Temperature used to replace the substring (FIELD) on the parametric URL name
urlAtmMesh_salS NOTUSED Name for the Surface Salinity used to replace the substring (FIELD) on the parametric URL name
urlAtmMesh_umid NOTUSED Name for the Air Humidity used to replace the substring (FIELD) on the parametric URL name
urlAtmMesh_radLW NOTUSED Name for the Long Wave Radiation used to replace the substring (FIELD) on the parametric URL name
urlAtmMesh_radSW NOTUSED Name for the Short Wave Radiation used to replace the substring (FIELD) on the parametric URL name
urlAtmMesh_snow NOTUSED Name for the 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 Description
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 Parametric filename for the Zonal Air Velocity datasets before the spinup-time (if 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 Parametric filename for the Meridional Air Velocity datasets before the spinup-time (if 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 Parametric filename for the Mean Sea-Level Pressure datasets before the spinup-time (if sbc_iformulat=0 or 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 Parametric filename for the Total Cloud Cover datasets before the spinup-time (if 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 Parametric filename for the Air Temperature datasets before the spinup-time (if 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 Parametric filename for the Dewpoint Temperature datasets before the spinup-time (if 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 Parametric filename for the Total Precipitation datasets before the spinup-time (if sbc_iformulat=0,2)
fileAtmMesh_filebase_tauU NOTUSED Parametric filename for the Zonal Wind Stress datasets before the spinup-time (if sbc_iformulat=1)
fileAtmMesh_filebase_tauV NOTUSED Parametric filename for the Meridional Wind Stress datasets before the spinup-time (if sbc_iformulat=1)
fileAtmMesh_lcompression False (=True) if the datasets you want to download are gzip compressed files (*.gz)
fileAtmMesh_llonFlip False (=True) if the longitude coordinate is in the 0 to 360 range, (=False) if longitude is in -180:+180 range
fileAtmMesh_llatInv True (=True) if the dataset contains latitude decreasing through the pole
fileAtmMesh_lkeepSrcFull True (=True) if you want to keep on your disk the downloaded uncutted 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 Description
srcDimAtmMesh_lon lon Name of the dimension for the longitude
srcDimAtmMesh_lat lat Name of the dimension for the latitude
srcDimAtmMesh_time time Name of the dimension for the time
srcCrdAtmMesh_lon lon Name of the coordinate variable containing the longitude
srcCrdAtmMesh_lat lat Name of the coordinate variable containing the latitude
srcCrdAtmMesh_time time Name of the variable containing the time coordinate
srcVarAtmMesh_mask LSM Name of the variable containing the Land Sea Mask (if sbc_iformulat=0,2)
srcVarAtmMesh_lont NOTUSED Name of the variable containing longitude coordinate of T-points (if sbc_iformulat=1)
srcVarAtmMesh_lonu NOTUSED Name of the variable containing longitude coordinate of U-points (if sbc_iformulat=1)
srcVarAtmMesh_lonv NOTUSED Name of the variable containing longitude coordinate of V-points (if sbc_iformulat=1)
srcVarAtmMesh_latt NOTUSED Name of the variable containing latitude coordinate of T-points (if sbc_iformulat=1)
srcVarAtmMesh_latu NOTUSED Name of the variable containing latitude coordinate of U-points (if sbc_iformulat=1)
srcVarAtmMesh_latv NOTUSED Name of the variable containing latitude coordinate of V-points (if sbc_iformulat=1)
srcVarAtmMesh_maskt NOTUSED Name of the variable containing the Land Sea Mask of T-points (if sbc_iformulat=1)
srcVarAtmMesh_masku NOTUSED Name of the variable containing the Land Sea Mask of U-points (if sbc_iformulat=1)
srcVarAtmMesh_maskv NOTUSED Name of the variable containing the Land Sea Mask of V-points (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 Description
urlAtmPre_usr myusername Username to access the input atmospheric datasets before the spinup-time from a remote FTP server
urlAtmPre_pwd mypwd Password to access the input atmospheric datasets before the spinup-time from a remote FTP server
urlAtmPre_urlbase file:///scratch/surf/indata_offline/gulfTaranto_20141005/data/data00/indata/atmosphere/srcFull Parametric URL name for atmospheric datasets before the spinup-time. Parameters: (FIELD),YYYY(p)MM(p)DD(p)
urlAtmPre_velU v10m Name for the Zonal Air Velocity used to replace the substring (FIELD) on the parametric URL name
urlAtmPre_velV v10m Name for the Meridional Air Velocity used to replace the substring (FIELD) on the parametric URL name
urlAtmPre_mslp mslp Name for the Mean Sea-Level Pressure used to replace the substring (FIELD) on the parametric URL name
urlAtmPre_cloudCov tcc Name for the Total Cloud Cover used to replace the substring (FIELD) on the parametric URL name
urlAtmPre_temp t2m Name for the Air Temperature used to replace the substring (FIELD) on the parametric URL name
urlAtmPre_dpTemp d2m Name for the Dewpoint Temperature used to replace the substring (FIELD) on the parametric URL name
urlAtmPre_prec precip Name for the Total Precipitation used to replace the substring (FIELD) on the parametric URL name
urlAtmPre_tauU tauU Name for the Zonal Wind Stress used to replace the substring (FIELD) on the parametric URL name
urlAtmPre_tauV tauV Name for the Meridional Wind Stress used to replace the substring (FIELD) on the parametric URL name
urlAtmPre_qtot qtot Name for the Total Heat Flux used to replace the substring (FIELD) on the parametric URL name
urlAtmPre_qsr qsr Name for the Solar Radiation Penetration used to replace the substring (FIELD) on the parametric URL name
urlAtmPre_emp emp Name for the Mass Flux Exchanged used to replace the substring (FIELD) on the parametric URL name
urlAtmPre_tempS sst Name for the Surface Temperature used to replace the substring (FIELD) on the parametric URL name
urlAtmPre_salS sss Name for the Surface Salinity used to replace the substring (FIELD) on the parametric URL name
urlAtmPre_umid umid Name for the Air Umidity used to replace the substring (FIELD) on the parametric URL name
urlAtmPre_radLW lwrd Name for the Long Wave Radiation used to replace the substring (FIELD) on the parametric URL name
urlAtmPre_radSW swrd Name for the Short Wave Radiation used to replace the substring (FIELD) on the parametric URL name
urlAtmPre_snow snow Name for the 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 Description
fileAtmPre_lcompression False (=True) if the datasets you want to download are gzip compressed files (*.gz)
fileAtmPre_iProdDate 1 Type of production (bulletin) date (=1):fixProdDate, (=2):varProdDate-DayofWeek
fileAtmPre_dateProdFixed 20170801 Production date used in the URL/files (if iProdDate=1)
fileAtmPre_dateProdDayofWeek Wednesday Production date used in the URL/files (if iProdDate=2)
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 Parametric filename for the Zonal Air Velocity datasets before the spinup-time (if 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 Parametric filename for the Meridional Air Velocity datasets before the spinup-time (if 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 Parametric filename for the Mean Sea-Level Pressure datasets before the spinup-time (if 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 Parametric filename for the Total Cloud Cover datasets before the spinup-time (if 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 Parametric filename for the Air Temperature datasets before the spinup-time (if 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 Parametric filename for the Dewpoint Temperature datasets before the spinup-time (if 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 Parametric filename for the Total Precipitation datasets before the spinup-time (if sbc_iformulat=0,2)
fileAtmPre_filebase_tauU NOTUSED Parametric filename for the Zonal Wind Stress datasets before the spinup-time (if sbc_iformulat=1)
fileAtmPre_filebase_tauV NOTUSED Parametric filename for the Meridional Wind Stress datasets before the spinup-time (if sbc_iformulat=1)
fileAtmPre_filebase_qtot NOTUSED Parametric filename for the Total Heat Flux datasets before the spinup-time (if 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.

set_dataDownlAtm_varName_preSpinup

Parameter Value Description
srcDimAtmPre_lon lon Name of the dimension for the longitude (if sbc_iformulat=0,2)
srcDimAtmPre_lont NOTUSED Name of the dimension for the longitude of T-points (if sbc_iformulat=1)
srcDimAtmPre_lonu NOTUSED Name of the dimension for the longitude of U-points (if sbc_iformulat=1)
srcDimAtmPre_lonv NOTUSED Name of the dimension for the longitude of V-points (if sbc_iformulat=1)
srcDimAtmPre_lat lat Name of the dimension for the latitude (if sbc_iformulat=0,2)
srcDimAtmPre_latt NOTUSED Name of the dimension for the latitude of T-points (if sbc_iformulat=1)
srcDimAtmPre_latu NOTUSED Name of the dimension for the latitude of U-points (if sbc_iformulat=1)
srcDimAtmPre_latv NOTUSED Name of the dimension for the latitude of V-points (if sbc_iformulat=1)
srcDimAtmPre_time time Name of the dimension for the time
srcCrdAtmPre_lon lon Name of the coordinate variable containing the longitude (if sbc_iformulat=0,2)
srcCrdAtmPre_lont NOTUSED Name of the coordinate variable containing the longitude of T-points (if sbc_iformulat=1)
srcCrdAtmPre_lonu NOTUSED Name of the coordinate variable containing the longitude of U-points (if sbc_iformulat=1)
srcCrdAtmPre_lonv NOTUSED Name of the coordinate variable containing the longitude of V-points (if sbc_iformulat=1)
srcCrdAtmPre_lat lat Name of the coordinate variable containing the latitude (if sbc_iformulat=0,2)
srcCrdAtmPre_latt NOTUSED Name of the coordinate variable containing the latitude of T-points (if sbc_iformulat=1)
srcCrdAtmPre_latu NOTUSED Name of the coordinate variable containing the latitude of U-points (if sbc_iformulat=1)
srcCrdAtmPre_latv NOTUSED Name of the coordinate variable containing the latitude of V-points (if sbc_iformulat=1)
srcCrdAtmPre_time time Name of the variable containing time coordinate
srcVarAtmPre_velU U10M Name of the variable for 10 metre zonal component of air velocity (if sbc_iformulat=0,2)
srcVarAtmPre_velV V10M Name of the variable for 10 metre meridional component of air velocity (if sbc_iformulat=0,2)
srcVarAtmPre_mslp MSL Name of the variable for Mean Sea-Level Pressure (if sbc_iformulat=0 or/and sbc_aprdyn)
srcVarAtmPre_cloudCov TCC Name of the variable for Total Cloud Cover (if sbc_iformulat=0)
srcVarAtmPre_temp T2M Name of the variable for 2 metre temperature (if sbc_iformulat=0,2)
srcVarAtmPre_dpTemp D2M Name of the variable for 2 metre Dewpoint Temperature (if sbc_iformulat=0)
srcVarAtmPre_prec PREC Name of the variable for Total Precipitation (if sbc_iformulat=0,2)
srcVarAtmPre_tauU NOTUSED Name of the variable for tauU (if sbc_iformulat=1)
srcVarAtmPre_tauV NOTUSED Name of the variable for tauV (if sbc_iformulat=1)
srcVarAtmPre_qtot NOTUSED Name of the variable for qtot (if sbc_iformulat=1)
srcVarAtmPre_qsr NOTUSED Name of the variable for qsr (if sbc_iformulat=1)
srcVarAtmPre_emp NOTUSED Name of the variable for emp (if sbc_iformulat=1)
srcVarAtmPre_tempS NOTUSED Name of the variable for tempS (if sbc_iformulat=1)
srcVarAtmPre_salS NOTUSED Name of the variable for salS (if sbc_iformulat=1)
srcVarAtmPre_umid NOTUSED Name of the variable for 2 metre umidity (if sbc_iformulat=2)
srcVarAtmPre_radLW NOTUSED Name of the variable for Long Wave Radiation (if sbc_iformulat=2)
srcVarAtmPre_radSW NOTUSED Name of the variable for Short Wave Radiation (if sbc_iformulat=2)
srcVarAtmPre_snow NOTUSED Name of the variable for Solid Precipitation (if 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 Description
urlAtmPost_usr myusername Username to access the input atmospheric datasets after the spinup-time from a remote ftp server
urlAtmPost_pwd mypwd Password to access the input atmospheric datasets after the spinup-time from a remote ftp server
urlAtmPost_urlbase file:///scratch/surf/indata_offline/gulfTaranto_20141005/data/data00/indata/atmosphere/srcFull Parametric urlname (i.e. ftp:/... or file:///...) for atmospheric datasets after the spinup-time. Parameters: (FIELD),YYYY(p)MM(p)DD(p)
urlAtmPost_velU v10m Name for the Zonal Air Velocity used to replace the substring (FIELD) on the parametrinc urlname
urlAtmPost_velV v10m Name for the Meridional Air Velocity used to replace the substring (FIELD) on the parametrinc urlname
urlAtmPost_mslp mslp Name for the Mean Sea-Level Pressure used to replace the substring (FIELD) on the parametrinc urlname
urlAtmPost_cloudCov tcc Name for the Total Cloud Cover used to replace the substring (FIELD) on the parametrinc urlname
urlAtmPost_temp t2m Name for the Air Temperature used to replace the substring (FIELD) on the parametrinc urlname
urlAtmPost_dpTemp d2m Name for the Dewpoint Temperature used to replace the substring (FIELD) on the parametrinc urlname
urlAtmPost_prec precip Name for the Total Precipitation used to replace the substring (FIELD) on the parametrinc urlname
urlAtmPost_tauU tauU Name for the Zonal Wind Stress used to replace the substring (FIELD) on the parametrinc urlname
urlAtmPost_tauV tauV Name for the Meridional Wind Stress used to replace the substring (FIELD) on the parametrinc urlname
urlAtmPost_qtot qtot Name for the Total Heat Flux used to replace the substring (FIELD) on the parametrinc urlname
urlAtmPost_qsr qsr Name for the Solar Radiation Penetration used to replace the substring (FIELD) on the parametrinc urlname
urlAtmPost_emp emp Name for the Mass Flux Exchanged used to replace the substring (FIELD) on the parametrinc urlname
urlAtmPost_tempS sst Name for the Surface Temperature used to replace the substring (FIELD) on the parametrinc urlname
urlAtmPost_salS sss Name for the Surface Salinity used to replace the substring (FIELD) on the parametrinc urlname
urlAtmPost_umid umid Name for the Air Umidity used to replace the substring (FIELD) on the parametrinc urlname
urlAtmPost_radLW lwrd Name for the Long Wave Radiation used to replace the substring (FIELD) on the parametrinc urlname
urlAtmPost_radSW swrd Name for the Short Wave Radiation used to replace the substring (FIELD) on the parametrinc urlname
urlAtmPost_snow snow Name for the Solid Precipitation used to replace the substring (FIELD) on the parametrinc urlname

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 Description
fileAtmPost_lcompression False Enables if datasets you want to download are gzip compressed files (*.gz)
fileAtmPost_iProdDate 1 Type of production (bulletin) date (=1):fixProdDate, (=2):varProdDate-DayofWeek
fileAtmPost_dateProdFixed 20170801 Production date used in the URL/files (if iProdDate=1)
fileAtmPost_dateProdDayofWeek Wednesday Production date used in the URL/files (if iProdDate=2)
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 Parametric filename for the Zonal Air Velocity datasets after the spinup-time (if sbc_iformulat=0,2)
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 Parametric filename for the Meridional Air Velocity datasets after the spinup-time (if sbc_iformulat=0,2)
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 Parametric filename for the Mean Sea-Level Pressure datasets after the spinup-time (if sbc_iformulat=0 or/and sbc_aprdyn)
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 Parametric filename for the Total Cloud Cover datasets after the spinup-time (if sbc_iformulat=0)
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 Parametric filename for the Air Temperature datasets after the spinup-time (if sbc_iformulat=0,2)
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 Parametric filename for the Dewpoint Temperature datasets after the spinup-time (if sbc_iformulat=0)
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 Parametric filename for the Total Precipitation datasets after the spinup-time (if sbc_iformulat=0,2)
fileAtmPost_filebase_tauU NOTUSED Parametric filename for the Zonal Wind Stress datasets after the spinup-time (if sbc_iformulat=1)
fileAtmPost_filebase_tauV NOTUSED Parametric filename for the Meridional Wind Stress datasets after the spinup-time (if sbc_iformulat=1)
fileAtmPost_filebase_qtot NOTUSED Parametric filename for the Total Heat Flux datasets after the spinup-time (if sbc_iformulat=1)
fileAtmPost_filebase_qsr NOTUSED Parametric filename for the Solar Radiation Penetration datasets after the spinup-time (if sbc_iformulat=1)
fileAtmPost_filebase_emp NOTUSED Parametric filename for the Mass Flux Exchanged datasets after the spinup-time (if sbc_iformulat=1)
fileAtmPost_filebase_tempS NOTUSED Parametric filename for the Surface Temperature datasets after the spinup-time (if sbc_iformulat=1)
fileAtmPost_filebase_salS NOTUSED Parametric filename for the Surface Salinity datasets after the spinup-time (if sbc_iformulat=1)
fileAtmPost_filebase_umid NOTUSED Parametric filename for the Air Umidity datasets after the spinup-time (if sbc_iformulat=1)
fileAtmPost_filebase_radLW NOTUSED Parametric filename for the Long Wave Radiation datasets after the spinup-time (if sbc_iformulat=1)
fileAtmPost_filebase_radSW NOTUSED Parametric filename for the Short Wave Radiation datasets after the spinup-time (if sbc_iformulat=1)
fileAtmPost_filebase_snow NOTUSED Parametric filename for the Solid Precipitation datasets after the spinup-time (if sbc_iformulat=1)

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 Description
srcDimAtmPost_lon lon Name of the dimension for the longitude (if sbc_iformulat=0,2)
srcDimAtmPost_lont NOTUSED Name of the dimension for the longitude of T-points (if sbc_iformulat=1)
srcDimAtmPost_lonu NOTUSED Name of the dimension for the longitude of U-points (if sbc_iformulat=1)
srcDimAtmPost_lonv NOTUSED Name of the dimension for the longitude of V-points (if sbc_iformulat=1)
srcDimAtmPost_lat lat Name of the dimension for the latitude (if sbc_iformulat=0,2)
srcDimAtmPost_latt NOTUSED Name of the dimension for the latitude of T-points (if sbc_iformulat=1)
srcDimAtmPost_latu NOTUSED Name of the dimension for the latitude of U-points (if sbc_iformulat=1)
srcDimAtmPost_latv NOTUSED Name of the dimension for the latitude of V-points (if sbc_iformulat=1)
srcDimAtmPost_time time Name of the dimension for the time
srcCrdAtmPost_lon lon Name of the coordinate variable containing the longitude (if sbc_iformulat=0,2)
srcCrdAtmPost_lont NOTUSED Name of the coordinate variable containing the longitude of T-points (if sbc_iformulat=1)
srcCrdAtmPost_lonu NOTUSED Name of the coordinate variable containing the longitude of U-points (if sbc_iformulat=1)
srcCrdAtmPost_lonv NOTUSED Name of the coordinate variable containing the longitude of V-points (if sbc_iformulat=1)
srcCrdAtmPost_lat lat Name of the coordinate variable containing the latitude (if sbc_iformulat=0,2)
srcCrdAtmPost_latt NOTUSED Name of the coordinate variable containing the latitude of T-points (if sbc_iformulat=1)
srcCrdAtmPost_latu NOTUSED Name of the coordinate variable containing the latitude of U-points (if sbc_iformulat=1)
srcCrdAtmPost_latv NOTUSED Name of the coordinate variable containing the latitude of V-points (if sbc_iformulat=1)
srcCrdAtmPost_time time Name of the variable containing time coordinate
srcVarAtmPost_velU U10M Name of the variable for 10 metre zonal component of air velocity (if sbc_iformulat=0,2)
srcVarAtmPost_velV V10M Name of the variable for 10 metre meridional component of air velocity (if sbc_iformulat=0,2)
srcVarAtmPost_mslp MSL Name of the variable for Mean Sea-Level Pressure (if sbc_iformulat=0 or/and sbc_aprdyn)
srcVarAtmPost_cloudCov TCC Name of the variable for Total Cloud Cover (if sbc_iformulat=0)
srcVarAtmPost_temp T2M Name of the variable for 2 metre temperature (if sbc_iformulat=0,2)
srcVarAtmPost_dpTemp D2M Name of the variable for 2 metre Dewpoint Temperature (if sbc_iformulat=0)
srcVarAtmPost_prec PREC Name of the variable for Total Precipitation (if sbc_iformulat=0,2)
srcVarAtmPost_tauU NOTUSED Name of the variable for tauU (if sbc_iformulat=1)
srcVarAtmPost_tauV NOTUSED Name of the variable for tauV (if sbc_iformulat=1)
srcVarAtmPost_qtot NOTUSED Name of the variable for qtot (if sbc_iformulat=1)
srcVarAtmPost_qsr NOTUSED Name of the variable for qsr (if sbc_iformulat=1)
srcVarAtmPost_emp NOTUSED Name of the variable for emp (if sbc_iformulat=1)
srcVarAtmPost_tempS NOTUSED Name of the variable for tempS (if sbc_iformulat=1)
srcVarAtmPost_salS NOTUSED Name of the variable for salS (if sbc_iformulat=1)
srcVarAtmPost_umid NOTUSED Name of the variable for 2 metre humidity (if sbc_iformulat=2)
srcVarAtmPost_radLW NOTUSED Name of the variable for Long Wave Radiation (if sbc_iformulat=2)
srcVarAtmPost_radSW NOTUSED Name of the variable for Short Wave Radiation (if sbc_iformulat=2)
srcVarAtmPost_snow NOTUSED Name of the variable for Solid Precipitation (if 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 Description
urlOceICMesh_usr myusername Username to access the input ocean IC meshmask datasets from a remote FTP server
urlOceICMesh_pwd mypwd Password to access the input ocean IC meshmask datasets from a remote FTP server
urlOceICMesh_urlbase file:///scratch/surf/indata_offline/gulfTaranto_20141005/data/data00/indata/oceanIC/srcFull Parametric URL for the input ocean IC meshmask datasets. Parameters: (FIELD)
urlOceICMesh_lont NOTUSED Name for the longitude-Tgrid used to replace the substring (FIELD) on the parametric URL
urlOceICMesh_lonu NOTUSED Name for the longitude-Ugrid used to replace the substring (FIELD) on the parametric URL
urlOceICMesh_lonv NOTUSED Name for the longitude-Vgrid used to replace the substring (FIELD) on the parametric URL
urlOceICMesh_lonf NOTUSED Name for the longitude-Fgrid used to replace the substring (FIELD) on the parametric URL
urlOceICMesh_latt NOTUSED Name for the latitude-Tgrid used to replace the substring (FIELD) on the parametric URL
urlOceICMesh_latu NOTUSED Name for the latitude-Ugrid used to replace the substring (FIELD) on the parametric URL
urlOceICMesh_latv NOTUSED Name for the latitude-Vgrid used to replace the substring (FIELD) on the parametric URL
urlOceICMesh_latf NOTUSED Name for the latitude-Fgrid used to replace the substring (FIELD) on the parametric URL
urlOceICMesh_deptht1d NOTUSED Name for the depth-Tgrid used to replace the substring (FIELD) on the parametric URL
urlOceICMesh_depthw1d NOTUSED Name for the depth-Wgrid used to replace the substring (FIELD) on the parametric URL
urlOceICMesh_xscalfctt NOTUSED Name for the scaleFactor-Tgrid x-direction used to replace the substring (FIELD) on the URL
urlOceICMesh_xscalfctu NOTUSED Name for the scaleFactor-Ugrid x-direction used to replace the substring (FIELD) on the URL
urlOceICMesh_xscalfctv NOTUSED Name for the scaleFactor-Vgrid x-direction used to replace the substring (FIELD) on the URL
urlOceICMesh_yscalfctt NOTUSED Name for the scaleFactor-Tgrid y-direction used to replace the substring (FIELD) on the URL
urlOceICMesh_yscalfctu NOTUSED Name for the scaleFactor-Ugrid y-direction used to replace the substring (FIELD) on the URL
urlOceICMesh_yscalfctv NOTUSED Name for the scaleFactor-Vgrid y-direction used to replace the substring (FIELD) on the URL
urlOceICMesh_maskt NOTUSED Name for the LandSea-mask-Tgrid used to replace the substring (FIELD) on the parametric URL
urlOceICMesh_masku NOTUSED Name for the LandSea-mask-Ugrid used to replace the substring (FIELD) on the parametric URL
urlOceICMesh_maskv NOTUSED Name for the LandSea-mask-Vgrid used to replace the substring (FIELD) on the parametric URL

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 Description
fileOceICMesh_filebase meshmask_SYS4a3_IONIAN.nc Parametric filename for ocean IC meshmask input datasets. Parameters: (FIELD)
fileOceICMesh_lont NOTUSED Name for the longitude-Tgrid used to replace the substring (FIELD) on the parametric filename
fileOceICMesh_lonu NOTUSED Name for the longitude-Ugrid used to replace the substring (FIELD) on the parametric filename
fileOceICMesh_lonv NOTUSED Name for the longitude-Vgrid used to replace the substring (FIELD) on the parametric filename
fileOceICMesh_lonf NOTUSED Name for the longitude-Fgrid used to replace the substring (FIELD) on the parametric filename
fileOceICMesh_latt NOTUSED Name for the latitude-Tgrid used to replace the substring (FIELD) on the parametric filename
fileOceICMesh_latu NOTUSED Name for the latitude-Ugrid used to replace the substring (FIELD) on the parametric filename
fileOceICMesh_latv NOTUSED Name for the latitude-Vgrid used to replace the substring (FIELD) on the parametric filename
fileOceICMesh_latf NOTUSED Name for the latitude-Fgrid used to replace the substring (FIELD) on the parametric filename
fileOceICMesh_deptht1d NOTUSED Name for the depth-Tgrid used to replace the substring (FIELD) on the parametric filename
fileOceICMesh_depthw1d NOTUSED Name for the depth-Wgrid used to replace the substring (FIELD) on the parametric filename
fileOceICMesh_xscalfctt NOTUSED Name for the scaleFactor-Tgrid x-direction used to replace the substring (FIELD) on the filename
fileOceICMesh_xscalfctu NOTUSED Name for the scaleFactor-Ugrid x-direction used to replace the substring (FIELD) on the filename
fileOceICMesh_xscalfctv NOTUSED Name for the scaleFactor-Vgrid x-direction used to replace the substring (FIELD) on the filename
fileOceICMesh_yscalfctt NOTUSED Name for the scaleFactor-Tgrid y-direction used to replace the substring (FIELD) on the filename
fileOceICMesh_yscalfctu NOTUSED Name for the scaleFactor-Ugrid y-direction used to replace the substring (FIELD) on the filename
fileOceICMesh_yscalfctv NOTUSED Name for the scaleFactor-Vgrid y-direction used to replace the substring (FIELD) on the filename
fileOceICMesh_maskt NOTUSED Name for the LandSea-mask-Tgrid used to replace the substring (FIELD) on the parametric filename
fileOceICMesh_masku NOTUSED Name for the LandSea-mask-Ugrid used to replace the substring (FIELD) on the parametric filename
fileOceICMesh_maskv NOTUSED Name for the LandSea-mask-Vgrid used to replace the substring (FIELD) on the parametric filename
fileOceICMesh_lcompression False (=True) if the datasets you want to download are gzip compressed files (*.gz)
fileOceICMesh_llonFlip False (=True) if the longitude coord. is in the 0 to 360 range, (=False) if in -180:+180 range
fileOceICMesh_llatInv False (=True) if the dataset contains latitude decreasing through the pole
fileOceICMesh_lstagC True (=True) if the input fields are defined on a staggered Arakawa C grid, (=False) if on T grid
fileOceICMesh_lRegGrid True (=True) for REGULAR SPHERICAL GRID, UV-rotation not activated, (=False) for CURVILINEAR GRID
fileOceICMesh_lkeepSrcFull True (=True) if you want to keep in your disk 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 Description
srcDimOceICMesh_lont x Name of the dimension for the longitude of T-points
srcDimOceICMesh_lonu x Name of the dimension for the longitude of U-points
srcDimOceICMesh_lonv x Name of the dimension for the longitude of V-points
srcDimOceICMesh_lonf x Name of the dimension for the longitude of F-points
srcDimOceICMesh_lonw x Name of the dimension for the longitude of W-points
srcDimOceICMesh_latt y Name of the dimension for the latitude of T-points
srcDimOceICMesh_latu y Name of the dimension for the latitude of U-points
srcDimOceICMesh_latv y Name of the dimension for the latitude of V-points
srcDimOceICMesh_latf y Name of the dimension for the latitude of F-points
srcDimOceICMesh_latw y Name of the dimension for the latitude of W-points
srcDimOceICMesh_deptht z Name of the dimension for the depth of T-points
srcDimOceICMesh_depthu z Name of the dimension for the depth of U-points
srcDimOceICMesh_depthv z Name of the dimension for the depth of V-points
srcDimOceICMesh_depthw z Name of the dimension for the depth of W-points
srcDimOceICMesh_time t Name of the dimension for the time
srcCrdOceICMesh_lont nav_lon Name of the coordinate variable for the longitude of T-points
srcCrdOceICMesh_lonu nav_lon Name of the coordinate variable for the longitude of U-points
srcCrdOceICMesh_lonv nav_lon Name of the coordinate variable for the longitude of V-points
srcCrdOceICMesh_lonf nav_lon Name of the coordinate variable for the longitude of F-points
srcCrdOceICMesh_latt nav_lat Name of the coordinate variable for the latitude of T-points
srcCrdOceICMesh_latu nav_lat Name of the coordinate variable for the latitude of U-points
srcCrdOceICMesh_latv nav_lat Name of the coordinate variable for the latitude of V-points
srcCrdOceICMesh_latf nav_lat Name of the coordinate variable for the latitude of F-points
srcCrdOceICMesh_deptht nav_lev Name of the coordinate variable for the depth of T-points
srcCrdOceICMesh_depthw nav_lev Name of the coordinate variable for the depth of W-points
srcCrdOceICMesh_time time_counter Name of the coordinate variable for the time
srcVarOceICMesh_lont glamt Name of the variable containing the longitude of T-points
srcVarOceICMesh_lonu glamu Name of the variable containing the longitude of U-points
srcVarOceICMesh_lonv glamv Name of the variable containing the longitude of V-points
srcVarOceICMesh_lonf glamf Name of the variable containing the longitude of F-points
srcVarOceICMesh_latt gphit Name of the variable containing the latitude of T-points
srcVarOceICMesh_latu gphiu Name of the variable containing the latitude of U-points
srcVarOceICMesh_latv gphiv Name of the variable containing the latitude of V-points
srcVarOceICMesh_latf gphif Name of the variable containing the latitude of F-points
srcVarOceICMesh_deptht1d gdept_0 Name of the variable containing depth coordinate
srcVarOceICMesh_depthw1d gdepw_0 Name of the variable containing depth coordinate
srcVarOceICMesh_xscalfctt e1t Name of the scale factors in zonal direction
srcVarOceICMesh_xscalfctu e1u Name of the scale factors in zonal direction
srcVarOceICMesh_xscalfctv e1v Name of the scale factors in zonal direction
srcVarOceICMesh_yscalfctt e2t Name of the scale factors in meridional direction
srcVarOceICMesh_yscalfctu e2u Name of the scale factors in meridional direction
srcVarOceICMesh_yscalfctv e2v Name of the scale factors in meridional direction
srcVarOceICMesh_maskt tmask Name of the land-sea-mask on T-points
srcVarOceICMesh_masku umask Name of the land-sea-mask on U-points
srcVarOceICMesh_maskv vmask 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 Description
urlOceIC_usr myusername Username to access the input ocean IC datasets from a remote FTP server
urlOceIC_pwd mypwd Password to access the input ocean IC datasets from a remote FTP server
urlOceIC_urlbase file:///scratch/surf/indata_offline/gulfTaranto_20141005/data/data00/indata/oceanIC/srcFull Parametric URL for the input ocean 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 NOTUSED Name for the Temperature used to replace the substring (FIELD) on the parametric URL
urlOceIC_sal NOTUSED Name for the Salinity used to replace the substring (FIELD) on the parametric URL
urlOceIC_ssh NOTUSED Name for the Sea Surface Height used to replace the substring (GRID) on the parametric URL
urlOceIC_velU NOTUSED Name for the Zonal Current used to replace the substring (GRID) on the parametric URL
urlOceIC_velV NOTUSED Name for the Meridional Current used to replace the substring (FIELD) on the parametric URL
urlOceIC_tempGrid NOTUSED Name for the Temperature used to replace the substring (GRID) on the parametric URL
urlOceIC_salGrid NOTUSED Name for the Salinity used to replace the substring (GRID) on the parametric URL
urlOceIC_sshGrid NOTUSED Name for the Sea Surface Height used to replace the substring (GRID) on the parametric URL
urlOceIC_velUGrid NOTUSED Name for the Zonal Current used to replace the substring (GRID) on the parametric URL
urlOceIC_velVGrid NOTUSED Name for the Meridional Current used to replace the substring (GRID) on the parametric URL

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 Description
fileOceIC_filebase EXP1_EAS1_1d_YYYY(i)MM(i)DD(i)_YYYY(i+1)MM(i+1)DD(i+1)_(GRID)_IONIAN.nc Parametric filename for ocean IC 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_iProdDate 1 Filename format to be downloaded (=1): fixProdDate, (=2): varProdDate-DayofWeek
fileOceIC_dateProdFixed 20170801 Datasets production (if iProdDate=1) used in the URL/files
fileOceIC_dateProdDayofWeek Wednesday Datasets production (if iProdDate=2) used in the URL/files
fileOceIC_temp TEMP Name for the Temperature used to replace the substring (FIELD) on the parametric filename
fileOceIC_sal PSAL Name for the Salinity used to replace the substring (FIELD) on the parametric filename
fileOceIC_ssh ASLV Name for the Sea Surface Height used to replace the substring (FIELD) on the parametric filename
fileOceIC_velU UCOM Name for the Zonal Current used to replace the substring (FIELD) on the parametric filename
fileOceIC_velV VCOM Name for the Meridional Current used to replace the substring (FIELD) on the parametric filename
fileOceIC_tempGrid grid_T Name for the Temperature used to replace the substring (GRID) on the parametric filename
fileOceIC_salGrid grid_T Name for the Salinity used to replace the substring (GRID) on the parametric filename
fileOceIC_sshGrid grid_T Name for the Sea Surface Height used to replace the substring (GRID) on the parametric filename
fileOceIC_velUGrid grid_U Name for the Zonal Current used to replace the substring (GRID) on the parametric filename
fileOceIC_velVGrid grid_V Name for the Meridional Current used to replace the substring (GRID) on the parametric filename
fileOceIC_lcompression False Enables if datasets you want to download are gzip compressed files (*.gz)

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 Description
srcDimOceIC_lont x Name of the dimension for the longitude of T-points
srcDimOceIC_lonu x Name of the dimension for the longitude of U-points
srcDimOceIC_lonv x Name of the dimension for the longitude of V-points
srcDimOceIC_lonw x Name of the dimension for the longitude of W-points
srcDimOceIC_latt y Name of the dimension for the latitude of T-points
srcDimOceIC_latu y Name of the dimension for the latitude of U-points
srcDimOceIC_latv y Name of the dimension for the latitude of V-points
srcDimOceIC_latw y Name of the dimension for the latitude of W-points
srcDimOceIC_deptht deptht Name of the dimension for the depth of T-points
srcDimOceIC_depthu depthu Name of the dimension for the depth of U-points
srcDimOceIC_depthv depthv Name of the dimension for the depth of V-points
srcDimOceIC_depthw depthw Name of the dimension for the depth of W-points
srcDimOceIC_time t Name of the dimension for the time
srcCrdOceIC_lont nav_lon Name of the coordinate variable for the longitude of T-points
srcCrdOceIC_lonu nav_lon Name of the coordinate variable for the longitude of U-points
srcCrdOceIC_lonv nav_lon Name of the coordinate variable for the longitude of V-points
srcCrdOceIC_lonw nav_lon Name of the coordinate variable for the longitude of W-points
srcCrdOceIC_latt nav_lat Name of the coordinate variable for the latitude of T-points
srcCrdOceIC_latu nav_lat Name of the coordinate variable for the latitude of U-points
srcCrdOceIC_latv nav_lat Name of the coordinate variable for the latitude of V-points
srcCrdOceIC_latw nav_lat Name of the coordinate variable for the latitude of W-points
srcCrdOceIC_deptht deptht Name of the coordinate variable for the depth of T-points
srcCrdOceIC_depthu depthu Name of the coordinate variable for the depth of U-points
srcCrdOceIC_depthv depthv Name of the coordinate variable for the depth of V-points
srcCrdOceIC_depthw depthw Name of the coordinate variable for the depth of W-points
srcCrdOceIC_time time_counter Name of the coordinate variable for the time
srcVarOceIC_temp votemper Name of the variable for the Temperature
srcVarOceIC_sal vosaline Name of the variable for the Salinity
srcVarOceIC_ssh sossheig Name of the variable for the Sea Surface Height
srcVarOceIC_velU vozocrtx Name of the variable for the Zonal Current
srcVarOceIC_velV vomecrty 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 Description
urlOceBCMesh_usr myusername Username to access the input ocean BC meshmask datasets from a remote FTP server
urlOceBCMesh_pwd mupwd Password to access the input ocean BC meshmask datasets from a remote FTP server
urlOceBCMesh_urlbase file:///scratch/surf/indata_offline/gulfTaranto_20141005/data/data00/indata/oceanBC/srcFull Parametric URL for the input ocean BC meshmask datasets. Parameters: (FIELD)
urlOceBCMesh_lont NOTUSED Name for the longitude-Tgrid used to replace the substring (FIELD) on the parametric URL
urlOceBCMesh_lonu NOTUSED Name for the longitude-Ugrid used to replace the substring (FIELD) on the parametric URL
urlOceBCMesh_lonv NOTUSED Name for the longitude-Vgrid used to replace the substring (FIELD) on the parametric URL
urlOceBCMesh_lonf NOTUSED Name for the longitude-Fgrid used to replace the substring (FIELD) on the parametric URL
urlOceBCMesh_latt NOTUSED Name for the latitude-Tgrid used to replace the substring (FIELD) on the parametric URL
urlOceBCMesh_latu NOTUSED Name for the latitude-Ugrid used to replace the substring (FIELD) on the parametric URL
urlOceBCMesh_latv NOTUSED Name for the latitude-Vgrid used to replace the substring (FIELD) on the parametric URL
urlOceBCMesh_latf NOTUSED Name for the latitude-Fgrid used to replace the substring (FIELD) on the parametric URL
urlOceBCMesh_deptht1d NOTUSED Name for the depth-Tgrid used to replace the substring (FIELD) on the parametric URL
urlOceBCMesh_depthw1d NOTUSED Name for the depth-Wgrid used to replace the substring (FIELD) on the parametric URL
urlOceBCMesh_xscalfctt NOTUSED Name for the scaleFactor-Tgrid x-direction used to replace the substring (FIELD) on the parametric URL
urlOceBCMesh_xscalfctu NOTUSED Name for the scaleFactor-Ugrid x-direction used to replace the substring (FIELD) on the parametric URL
urlOceBCMesh_xscalfctv NOTUSED Name for the scaleFactor-Vgrid x-direction used to replace the substring (FIELD) on the parametric URL
urlOceBCMesh_yscalfctt NOTUSED Name for the scaleFactor-Tgrid y-direction used to replace the substring (FIELD) on the parametric URL
urlOceBCMesh_yscalfctu NOTUSED Name for the scaleFactor-Ugrid y-direction used to replace the substring (FIELD) on the parametric URL
urlOceBCMesh_yscalfctv NOTUSED Name for the scaleFactor-Vgrid y-direction used to replace the substring (FIELD) on the parametric URL
urlOceBCMesh_zscalfctt NOTUSED Name for the scaleFactor-Tgrid-3d z-direction used to replace the substring (FIELD) on the parametric URL (needed if obc_lvelCorr=True)
urlOceBCMesh_zscalfctu NOTUSED Name for the scaleFactor-Ugrid-3d z-direction used to replace the substring (FIELD) on the parametric URL (needed if obc_lvelCorr=True)
urlOceBCMesh_zscalfctv NOTUSED Name for the scaleFactor-Vgrid-3d z-direction used to replace the substring (FIELD) on the parametric URL (needed if obc_lvelCorr=True)
urlOceBCMesh_maskt NOTUSED Name for the LandSea-mask-Tgrid used to replace the substring (FIELD) on the parametric URL
urlOceBCMesh_masku NOTUSED Name for the LandSea-mask-Ugrid used to replace the substring (FIELD) on the parametric URL
urlOceBCMesh_maskv NOTUSED Name for the LandSea-mask-Vgrid used to replace the substring (FIELD) on the parametric URL

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 Description
fileOceBCMesh_filebase meshmask_SYS4a3_IONIAN.nc Parametric filename for ocean BC meshmask input datasets. Parameters: (FIELD)
fileOceBCMesh_lont NOTUSED Name for the longitude-Tgrid used to replace the substring (FIELD) on the parametric filename
fileOceBCMesh_lonu NOTUSED Name for the longitude-Ugrid used to replace the substring (FIELD) on the parametric filename
fileOceBCMesh_lonv NOTUSED Name for the longitude-Vgrid used to replace the substring (FIELD) on the parametric filename
fileOceBCMesh_lonf NOTUSED Name for the longitude-Fgrid used to replace the substring (FIELD) on the parametric filename
fileOceBCMesh_latt NOTUSED Name for the latitude-Tgrid used to replace the substring (FIELD) on the parametric filename
fileOceBCMesh_latu NOTUSED Name for the latitude-Ugrid used to replace the substring (FIELD) on the parametric filename
fileOceBCMesh_latv NOTUSED Name for the latitude-Vgrid used to replace the substring (FIELD) on the parametric filename
fileOceBCMesh_latf NOTUSED Name for the latitude-Fgrid used to replace the substring (FIELD) on the parametric filename
fileOceBCMesh_deptht1d NOTUSED Name for the depth-Tgrid used to replace the substring (FIELD) on the parametric filename
fileOceBCMesh_depthw1d NOTUSED Name for the depth-Wgrid used to replace the substring (FIELD) on the parametric filename
fileOceBCMesh_xscalfctt NOTUSED Name for the scaleFactor-Tgrid x-direction used to replace the substring (FIELD) on the filename
fileOceBCMesh_xscalfctu NOTUSED Name for the scaleFactor-Ugrid x-direction used to replace the substring (FIELD) on the filename
fileOceBCMesh_xscalfctv NOTUSED Name for the scaleFactor-Vgrid x-direction used to replace the substring (FIELD) on the filename
fileOceBCMesh_yscalfctt NOTUSED Name for the scaleFactor-Tgrid y-direction used to replace the substring (FIELD) on the filename
fileOceBCMesh_yscalfctu NOTUSED Name for the scaleFactor-Ugrid y-direction used to replace the substring (FIELD) on the filename
fileOceBCMesh_yscalfctv NOTUSED Name for the scaleFactor-Vgrid y-direction used to replace the substring (FIELD) on the filename
fileOceBCMesh_zscalfctt NOTUSED Name for the scaleFactor-Tgrid-3d z-direction used to replace the substring (FIELD) on the filename (needed if obc_lvelCorr=True)
fileOceBCMesh_zscalfctu NOTUSED Name for the scaleFactor-Ugrid-3d z-direction used to replace the substring (FIELD) on the filename (needed if obc_lvelCorr=True)
fileOceBCMesh_zscalfctv NOTUSED Name for the scaleFactor-Vgrid-3d z-direction used to replace the substring (FIELD) on the filename (needed if obc_lvelCorr=True)
fileOceBCMesh_maskt NOTUSED Name for the LandSea-mask-Tgrid used to replace the substring (FIELD) on the parametric filename
fileOceBCMesh_masku NOTUSED Name for the LandSea-mask-Ugrid used to replace the substring (FIELD) on the parametric filename
fileOceBCMesh_maskv NOTUSED Name for the LandSea-mask-Vgrid used to replace the substring (FIELD) on the parametric filename
fileOceBCMesh_lcompression False If the datasets are gzip compressed files (*.gz)
fileOceBCMesh_llonFlip False If the longitude coord. is in the 0 to 360 range (True) or -180 to +180 range (False)
fileOceBCMesh_llatInv False If the dataset contains latitude decreasing through the pole (True)
fileOceBCMesh_lstagC True If the input fields are defined on a staggered Arakawa C grid (True) or on a T grid (False)
fileOceBCMesh_lRegGrid True If the input fields are defined on a REGULAR SPHERICAL GRID (True) or CURVILINEAR NO-SPHERICAL GRID (False)
fileOceBCMesh_lkeepSrcFull True If you want to keep the downloaded uncutted datasets on your disk (True)

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 Description
srcDimOceBCMesh_lont x Name of the dimension for the longitude of T-points
srcDimOceBCMesh_lonu x Name of the dimension for the longitude of U-points
srcDimOceBCMesh_lonv x Name of the dimension for the longitude of V-points
srcDimOceBCMesh_lonf x Name of the dimension for the longitude of F-points
srcDimOceBCMesh_lonw x Name of the dimension for the longitude of W-points
srcDimOceBCMesh_latt y Name of the dimension for the latitude of T-points
srcDimOceBCMesh_latu y Name of the dimension for the latitude of U-points
srcDimOceBCMesh_latv y Name of the dimension for the latitude of V-points
srcDimOceBCMesh_latf y Name of the dimension for the latitude of F-points
srcDimOceBCMesh_latw y Name of the dimension for the latitude of W-points
srcDimOceBCMesh_deptht z Name of the dimension for the depth of T-points
srcDimOceBCMesh_depthu z Name of the dimension for the depth of U-points
srcDimOceBCMesh_depthv z Name of the dimension for the depth of V-points
srcDimOceBCMesh_depthw z Name of the dimension for the depth of W-points
srcDimOceBCMesh_time t Name of the dimension for the time
srcCrdOceBCMesh_lont nav_lon Name of the coordinate variable for the longitude of T-points
srcCrdOceBCMesh_lonu nav_lon Name of the coordinate variable for the longitude of U-points
srcCrdOceBCMesh_lonv nav_lon Name of the coordinate variable for the longitude of V-points
srcCrdOceBCMesh_lonf nav_lon Name of the coordinate variable for the longitude of F-points
srcCrdOceBCMesh_latt nav_lat Name of the coordinate variable for the latitude of T-points
srcCrdOceBCMesh_latu nav_lat Name of the coordinate variable for the latitude of U-points
srcCrdOceBCMesh_latv nav_lat Name of the coordinate variable for the latitude of V-points
srcCrdOceBCMesh_latf nav_lat Name of the coordinate variable for the latitude of F-points
srcCrdOceBCMesh_deptht nav_lev Name of the coordinate variable for the depth of T-points
srcCrdOceBCMesh_depthw nav_lev Name of the coordinate variable for the depth of W-points
srcCrdOceBCMesh_time nav_lev Name of the coordinate variable for the time
srcVarOceBCMesh_lont glamt Name of the variable containing the longitude of T-points
srcVarOceBCMesh_lonu glamu Name of the variable containing the longitude of U-points
srcVarOceBCMesh_lonv glamv Name of the variable containing the longitude of V-points
srcVarOceBCMesh_lonf glamf Name of the variable containing the longitude of F-points
srcVarOceBCMesh_latt gphit Name of the variable containing the latitude of T-points
srcVarOceBCMesh_latu gphiu Name of the variable containing the latitude of U-points
srcVarOceBCMesh_latv gphiv Name of the variable containing the latitude of V-points
srcVarOceBCMesh_latf gphif Name of the variable containing the latitude of F-points
srcVarOceBCMesh_deptht1d gdept_0 Name of the variable containing the depth of T-points
srcVarOceBCMesh_depthw1d gdepw_0 Name of the variable containing the depth of W-points
srcVarOceBCMesh_xscalfctt e1t Name of the scale factors in zonal direction of T-points
srcVarOceBCMesh_xscalfctu e1u Name of the scale factors in zonal direction of U-points
srcVarOceBCMesh_xscalfctv e1v Name of the scale factors in zonal direction of V-points
srcVarOceBCMesh_yscalfctt e2t Name of the scale factors in meridional direction of T-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 Description
urlOceBCPre_usr myusername Username to access the input ocean BC datasets from a remote FTP server
urlOceBCPre_pwd mypwd Password to access the input ocean BC datasets from a remote FTP server
urlOceBCPre_urlbase file:///scratch/surf/indata_offline/gulfTaranto_20141005/data/data00/indata/oceanBC/srcFull Parametric URL for the input ocean BC datasets. Parameters: (FIELD),(GRID),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)
urlOceBCPre_temp tem Name for the Temperature used to replace the substring (FIELD) on the parametric URL
urlOceBCPre_sal sal Name for the Salinity used to replace the substring (FIELD) on the parametric URL
urlOceBCPre_ssh ssh Name for the Sea Surface Height used to replace the substring (FIELD) on the parametric URL
urlOceBCPre_velU cur Name for the Zonal Current used to replace the substring (FIELD) on the parametric URL
urlOceBCPre_velV cur Name for the Merid. Current used to replace the substring (FIELD) on the parametric URL
urlOceBCPre_tempGrid gridT Name for the Temperature used to replace the substring (GRID) on the parametric URL
urlOceBCPre_salGrid gridT Name for the Salinity used to replace the substring (GRID) on the parametric URL
urlOceBCPre_sshGrid gridT Name for the Sea Surface Height used to replace the substring (GRID) on the parametric URL
urlOceBCPre_velUGrid gridU Name for the Zonal Current used to replace the substring (GRID) on the parametric URL
urlOceBCPre_velVGrid gridV Name for the Merid. Current used to replace the substring (GRID) on the parametric URL

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 Description
fileOceBCPre_filebase EXP1_EAS1_1d_YYYY(i)MM(i)DD(i)_YYYY(i+1)MM(i+1)DD(i+1)_(GRID)_IONIAN.nc Parametric filename for input ocean BC datasets. Parameters: (FIELD),(GRID),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)
fileOceBCPre_iProdDate 1 File name format to be downloaded: (=1):fixProdDate, (=2):varProdDate-DayofWeek
fileOceBCPre_dateProdFixed 20170801 Datasets production date used in the URL/files if iProdDate=1
fileOceBCPre_dateProdDayofWeek Wednesday Datasets production day of the week used in the URL/files if iProdDate=2
fileOceBCPre_temp TEMP Name for the Temperature used to replace the substring (FIELD) on the parametric filename
fileOceBCPre_sal PSAL Name for the Salinity used to replace the substring (FIELD) on the parametric filename
fileOceBCPre_ssh ASLV Name for the Sea Surface Height used to replace the substring (FIELD) on the parametric filename
fileOceBCPre_velU UCOM Name for the Zonal Current used to replace the substring (FIELD) on the parametric filename
fileOceBCPre_velV VCOM Name for the Meridional Current used to replace the substring (FIELD) on the parametric filename
fileOceBCPre_tempGrid grid_T Name for the Temperature grid used to replace the substring (GRID) on the parametric filename
fileOceBCPre_salGrid grid_T Name for the Salinity grid used to replace the substring (GRID) on the parametric filename
fileOceBCPre_sshGrid grid_T Name for the Sea Surface Height grid used to replace the substring (GRID) on the parametric filename
fileOceBCPre_velUGrid grid_U Name for the Zonal Current grid used to replace the substring (GRID) on the parametric filename
fileOceBCPre_velVGrid grid_V Name for the Meridional Current grid used to replace the substring (GRID) on the parametric filename
fileOceBCPre_lcompression False Enables gzip compression for downloaded datasets if True (*.gz files)

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 Description
srcDimOceBCPre_lont x Name of the dimension for the longitude
srcDimOceBCPre_lonu x Name of the dimension for the longitude
srcDimOceBCPre_lonv x Name of the dimension for the longitude
srcDimOceBCPre_lonw x Name of the dimension for the longitude
srcDimOceBCPre_latt y Name of the dimension for the latitude
srcDimOceBCPre_latu y Name of the dimension for the latitude
srcDimOceBCPre_latv y Name of the dimension for the latitude
srcDimOceBCPre_latw y Name of the dimension for the latitude
srcDimOceBCPre_deptht deptht Name of the dimension for the depth
srcDimOceBCPre_depthu depthu Name of the dimension for the depth
srcDimOceBCPre_depthv depthv Name of the dimension for the depth
srcDimOceBCPre_depthw depthw Name of the dimension for the depth
srcDimOceBCPre_time time_counter Name of the dimension for the time
srcCrdOceBCPre_lont nav_lon Name of the coordinate variable for the longitude
srcCrdOceBCPre_lonu nav_lon Name of the coordinate variable for the longitude
srcCrdOceBCPre_lonv nav_lon Name of the coordinate variable for the longitude
srcCrdOceBCPre_lonw nav_lon Name of the coordinate variable for the longitude
srcCrdOceBCPre_latt nav_lat Name of the coordinate variable for the latitude
srcCrdOceBCPre_latu nav_lat Name of the coordinate variable for the latitude
srcCrdOceBCPre_latv nav_lat Name of the coordinate variable for the latitude
srcCrdOceBCPre_latw nav_lat Name of the coordinate variable for the latitude
srcCrdOceBCPre_deptht deptht Name of the coordinate variable for the depth
srcCrdOceBCPre_depthu depthu Name of the coordinate variable for the depth
srcCrdOceBCPre_depthv depthv Name of the coordinate variable for the depth
srcCrdOceBCPre_depthw depthw Name of the coordinate variable for the depth
srcCrdOceBCPre_time time_counter Name of the coordinate variable for the time
srcVarOceBCPre_temp votemper Name of the variable for the Temperature
srcVarOceBCPre_sal vosaline Name of the variable for the Salinity
srcVarOceBCPre_ssh sossheig Name of the variable for the Sea Surface Height
srcVarOceBCPre_velU vozocrtx Name of the variable for the Zonal Current
srcVarOceBCPre_velV vomecrty Name of the variable for the Meridional 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 Description
urlOceBCPost_usr myusername Username to access the input ocean BC datasets from a remote FTP server
urlOceBCPost_pwd mypwd Password to access the input ocean BC datasets from a remote FTP server
urlOceBCPost_urlbase file:///scratch/surf/indata_offline/gulfTaranto_20141005/data/data00/indata/oceanBC/srcFull Parametric URL for the input ocean BC datasets. Parameters: (FIELD),(GRID),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)
urlOceBCPost_temp tem Name for the Temperature used to replace the substring (FIELD) on the parametric URL
urlOceBCPost_sal sal Name for the Salinity used to replace the substring (FIELD) on the parametric URL
urlOceBCPost_ssh ssh Name for the Sea Surface Height used to replace the substring (FIELD) on the parametric URL
urlOceBCPost_velU cur Name for the Zonal Current used to replace the substring (FIELD) on the parametric URL
urlOceBCPost_velV cur Name for the Merid. Current used to replace the substring (FIELD) on the parametric URL
urlOceBCPost_tempGrid gridT Name for the Temperature used to replace the substring (GRID) on the parametric URL
urlOceBCPost_salGrid gridT Name for the Salinity used to replace the substring (GRID) on the parametric URL
urlOceBCPost_sshGrid gridT Name for the Sea Surface Height used to replace the substring (GRID) on the parametric URL
urlOceBCPost_velUGrid gridU Name for the Zonal Current used to replace the substring (GRID) on the parametric URL
urlOceBCPost_velVGrid gridV Name for the Merid. Current used to replace the substring (GRID) on the parametric URL

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 Description
fileOceBCPost_filebase EXP1_EAS1_1d_YYYY(i)MM(i)DD(i)_YYYY(i+1)MM(i+1)DD(i+1)_(GRID)_IONIAN.nc Parametric filename for the input ocean BC datasets. Parameters: (FIELD),(GRID),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)
fileOceBCPost_iProdDate 1 Filename format to be downloaded (=1): fixProdDate, (=2): varProdDate-DayofWeek
fileOceBCPost_dateProdFixed 20170801 Datasets production date used in the URL/files (if iProdDate=1)
fileOceBCPost_dateProdDayofWeek Wednesday Datasets production date used in the URL/files (if iProdDate=2)
fileOceBCPost_temp TEMP Name for the Temperature used to replace the substring (FIELD) on the parametric filename
fileOceBCPost_sal PSAL Name for the Salinity used to replace the substring (FIELD) on the parametric filename
fileOceBCPost_ssh ASLV Name for the Sea Surface Height used to replace the substring (FIELD) on the parametric filename
fileOceBCPost_velU UCOM Name for the Zonal Current used to replace the substring (FIELD) on the parametric filename
fileOceBCPost_velV VCOM Name for the Merid. Current used to replace the substring (FIELD) on the parametric filename
fileOceBCPost_tempGrid grid_T Name for the Temperature used to replace the substring (GRID) on the parametric filename
fileOceBCPost_salGrid grid_T Name for the Salinity used to replace the substring (GRID) on the parametric filename
fileOceBCPost_sshGrid grid_T Name for the Sea Surface Height used to replace the substring (GRID) on the parametric filename
fileOceBCPost_velUGrid grid_U Name for the Zonal Current used to replace the substring (GRID) on the parametric filename
fileOceBCPost_velVGrid grid_V Name for the Merid. Current used to replace the substring (GRID) on the parametric filename
fileOceBCPost_lcompression False Enables if datasets you want to download are gzip compressed files (*.gz)

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 Description
srcDimOceBCPost_lont x Name of the dimension for the longitude
srcDimOceBCPost_lonu x Name of the dimension for the longitude
srcDimOceBCPost_lonv x Name of the dimension for the longitude
srcDimOceBCPost_lonw x Name of the dimension for the longitude
srcDimOceBCPost_latt y Name of the dimension for the latitude
srcDimOceBCPost_latu y Name of the dimension for the latitude
srcDimOceBCPost_latv y Name of the dimension for the latitude
srcDimOceBCPost_latw y Name of the dimension for the latitude
srcDimOceBCPost_deptht deptht Name of the dimension for the depth
srcDimOceBCPost_depthu depthu Name of the dimension for the depth
srcDimOceBCPost_depthv depthv Name of the dimension for the depth
srcDimOceBCPost_depthw depthw Name of the dimension for the depth
srcDimOceBCPost_time time_counter Name of the dimension for the time
srcCrdOceBCPost_lont nav_lon Name of the coordinate variable for the longitude
srcCrdOceBCPost_lonu nav_lon Name of the coordinate variable for the longitude
srcCrdOceBCPost_lonv nav_lon Name of the coordinate variable for the longitude
srcCrdOceBCPost_lonw nav_lon Name of the coordinate variable for the longitude
srcCrdOceBCPost_latt nav_lat Name of the coordinate variable for the latitude
srcCrdOceBCPost_latu nav_lat Name of the coordinate variable for the latitude
srcCrdOceBCPost_latv nav_lat Name of the coordinate variable for the latitude
srcCrdOceBCPost_latw nav_lat Name of the coordinate variable for the latitude
srcCrdOceBCPost_deptht deptht Name of the coordinate variable for the depth
srcCrdOceBCPost_depthu depthu Name of the coordinate variable for the depth
srcCrdOceBCPost_depthv depthv Name of the coordinate variable for the depth
srcCrdOceBCPost_depthw depthw Name of the coordinate variable for the depth
srcCrdOceBCPost_time time_counter Name of the coordinate variable for the time
srcVarOceBCPost_temp votemper Name of the variable for the Temperature
srcVarOceBCPost_sal vosaline Name of the variable for the Salinity
srcVarOceBCPost_ssh sossheig Name of the variable for the Sea Surface Height
srcVarOceBCPost_velU vozocrtx Name of the variable for the Zonal Current
srcVarOceBCPost_velV vomecrty Name of the variable for the Meridional Current

Data Manipulation Settings

set_manipolBat

This section defines the parameters for modifying and controlling bathymetry values within the simulation domain.

Parameter Value Description
manipBat_seaLevel 0.0 Value to add to bathymetry to modify surface elevation (e.g., Caspian Sea 28 meters)
manipBat_minDepth 5.0 Minimum bathymetry value of the whole domain (at sea grid points)
manipBat_maxDepth 22000.0 Maximum bathymetry value of the whole domain (at sea grid points)
manipBat_lmoveDepth True Enables the modification of bathymetry in rectangular regions
manipBatMoveDepth_lonWest 18.0 Longitude of the western boundary of rectangular regions where you want to move the depth
manipBatMoveDepth_lonEast 18.5 Longitude of the eastern boundary of rectangular regions where you want to move the depth
manipBatMoveDepth_latSout 40.3 Latitude of the southern boundary of rectangular regions where you want to move the depth
manipBatMoveDepth_latNort 40.7 Latitude of the northern boundary of rectangular regions where you want to move the depth
manipBatMoveDepth_depth 0.0 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 Description
norder_shapFiltBat 2 Order of the Shapiro Filter for the bathymetry data
nloop_shapFiltBat 4 Number of applications of the Shapiro Filter for the bathymetry data

set_shapFiltOce

This section defines the parameters for applying a Shapiro filter to the output ocean data.

Parameter Value Description
norder_shapFiltOce 2 Order of the Shapiro Filter for the ocean output data
nloop_shapFiltOce 10 Number of applications of the Shapiro Filter for the ocean output data

Interpolation Method Settings

set_interpMethodBat

This section specifies the interpolation method to be used when processing bathymetric elevation data.

Parameter Value Description
interpMethodBat_elev bilin Remapping method to use for the Sea Floor Elevation: bilin, bicub, distwgt

set_interpMethodAtm

This section defines the interpolation methods used for remapping the atmospheric data fields required by the simulation.

Parameter Value Description
interpMethodAtm_velU bilin Remapping method for the zonal component of air velocity
interpMethodAtm_velV bilin Remapping method for the meridional component of air velocity
interpMethodAtm_temp bilin Remapping method for Air Temperature
interpMethodAtm_dpTemp bilin Remapping method for Dewpoint Temperature
interpMethodAtm_mslp bilin Remapping method for mean sea level pressure
interpMethodAtm_cloudCover bilin Remapping method for Cloud Cover
interpMethodAtm_prec bilin Remapping method for Total Precipitation
interpMethodAtm_tauU bilin Remapping method for Zonal Wind Stress
interpMethodAtm_tauV bilin Remapping method for Meridional Wind Stress
interpMethodAtm_qtot bilin Remapping method for Total Heat Flux
interpMethodAtm_qsr bilin Remapping method for Solar Radiation Penetration
interpMethodAtm_emp bilin Remapping method for Mass Flux Exchanged
interpMethodAtm_tempS bilin Remapping method for Surface Temperature
interpMethodAtm_salS bilin Remapping method for Surface Salinity
interpMethodAtm_umid bilin Remapping method for Air Umidity
interpMethodAtm_radLW bilin Remapping method for Long Wave Radiation
interpMethodAtm_radSW bilin Remapping method for Short Wave Radiation
interpMethodAtm_snow bilin Remapping method for Solid Precipitation

set_interpMethodOceIC

This section defines the interpolation methods used for remapping the ocean initial condition data fields necessary for the simulation.

Parameter Value Description
interpMethodOceIC_temp bilin Remapping method for Temperature
interpMethodOceIC_sal bilin Remapping method for Salinity
interpMethodOceIC_ssh bilin Remapping method for Sea Surface Height
interpMethodOceIC_velU bilin Remapping method for Zonal Current
interpMethodOceIC_velV bilin Remapping method for Meridional Current

set_interpMethodOceBC

This section defines the interpolation methods used for remapping the ocean boundary condition data fields required by the simulation.

Parameter Value Description
interpMethodOceBC_temp bilin Remapping method for Temperature
interpMethodOceBC_sal bilin Remapping method for Salinity
interpMethodOceBC_ssh bilin Remapping method for Sea Surface Height
interpMethodOceBC_velU bilin Remapping method for Zonal Current
interpMethodOceBC_velV bilin Remapping method for Meridional Current

set_interpMethodTide

This section defines the interpolation methods used for remapping the tidal data fields required by the simulation.

Parameter Value Description
interpMethodTide_elev bilin Remapping method for Tidal elevation
interpMethodTide_velU bilin Remapping method for Tidal Zonal transport
interpMethodTide_velV bilin Remapping method for Tidal Meridional transport

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 Description
lvarOceOutT_temp True Enables writing the Temperature (votemper) field in the output file
lvarOceOutT_sal True Enables writing the Salinity (vosaline) field in the output file
lvarOceOutT_tempS False Enables writing the Surface Temperature (sosstsst) field in the output file
lvarOceOutT_salS False Enables writing the Surface Salinity (sosaline) field in the output file
lvarOceOutT_ssh True Enables writing the Sea Surface Height (sossheig) field in the output file
lvarOceOutT_fluxWater_up False Enables writing the Net Upward Water Flux (sowaflup) field in the output file
lvarOceOutT_fluxSalt_down False Enables writing the Downward Salt Flux (sosfldow) field in the output file
lvarOceOutT_fluxHeat_down False Enables writing the Net Downward Heat Flux (sohefldo) field in the output file
lvarOceOutT_fluxHeatS_damp False Enables writing the Surface Heat Flux: Damping (sohefldp) field in the output file
lvarOceOutT_fluxWaterS_damp False Enables writing the Surface Water Flux: Damping (sowafldp) field in the output file
lvarOceOutT_fluxSaltS_damp False Enables writing the Surface Salt Flux: Damping (sosafldp) field in the output file
lvarOceOutT_runoffs False Enables writing the River Runoffs (sorunoff) field in the output file
lvarOceOutT_tempConcen False Enables writing the Concentration/Dilution term on Temperature (sosst_cd)
lvarOceOutT_salConcen False Enables writing the Concentration/Dilution term on Salinity (sosss_cd)
lvarOceOutT_radSW False Enables writing the Shortwave Radiation (soshfldo) field in the output file
lvarOceOutT_depthTurb False Enables writing the Turbocline Depth (somixhgt) field in the output file
lvarOceOutT_mld False Enables writing the Mixed Layer Depth 0.01 (somxl010) field in the output file
lvarOceOutT_iceFrac False Enables writing the Ice Fraction (soicecov) field in the output file
lvarOceOutT_wind10 False Enables writing the Wind Speed at 10m (sowindsp) field in the output file
lvarOceOutT_bowlin False Enables writing the 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 Description
lvarOceOutU_velU True Enables writing the Zonal Current (vozocrtx) field in the output file
lvarOceOutU_tauU False Enables writing the 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 Description
lvarOceOutV_velV True Enables writing the Meridional Current (vomecrty) field in the output file
lvarOceOutV_tauV False Enables writing the Meridional Wind Stress (sometauy) field in the output file

set_lvarOceOutW

Parameter Value Description
lvarOceOutW_velW False Enables writing the Vertical Velocity (vovecrtz) field in the output file
lvarOceOutW_eddyDiffW False Enables writing the Vertical Eddy Diffusivity (votkeavt) field in the output file
lvarOceOutW_eddyViscW False Enables writing the Vertical Eddy Viscosity (votkeavm) field in the output file

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.


set_lzip

This section contains the gzip compression settings for various output data files, providing options to enable or disable compression for different data types.

Parameter Value Description
lzip_indata False Enable/disable gzip compression of the Indata Bat, Atm, OceIC, OceBC files
lzip_extrapdata False Enable/disable gzip compression of the Extrapdata Atm, OceIC, OceBC files
lzip_regriddata False Enable/disable gzip compression of the Regriddata Bat, Atm, OceIC, OceBC, OceBCbdy files
lzip_outdata False Enable/disable gzip compression of the Outdata Ocean files

set_nemoCPPkey

This section contains the compilation keys used to compile the NEMO code.

Parameter Value Description
cppkey_zdf key_zdfric Name of CPP-keys for Vertical viscosity/diffusivity (e.g., key_zdfric, key_zdftke)
cppkey_spg key_dynspg_ts Name of CPP-keys for Surface Pressure Gradient (e.g., key_dynspg_exp, key_dynspg_flt, key_dynspg_ts)
cppkey_obc key_bdy Name of CPP-keys for Open Boundary Conditions (e.g., key_bdy)
cppkey_tide NOTUSED Name of CPP-keys for Tidal Potential forcing (e.g., key_tide)
cppkey_hpc key_mpp_mpi Name of CPP-keys for Massively Parallel Processing (e.g., key_mpp_mpi)
cppkey_dia NOTUSED Name of CPP-keys for Instantaneous output (e.g., key_diainstant)
cppkey_signfunc key_nosignedzero Name of CPP-keys to handle intrinsic SIGN function for Fortran compiler (e.g., key_nosignedzero)