rompy.schism.config.SchismCSIROConfig#
- pydantic model rompy.schism.config.SchismCSIROConfig[source]#
Show JSON schema
{ "title": "SchismCSIROConfig", "type": "object", "properties": { "model_type": { "const": "schismcsiro", "default": "schismcsiro", "description": "The model type for SCHISM.", "title": "Model Type", "type": "string" }, "template": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": "/opt/hostedtoolcache/Python/3.10.17/x64/lib/python3.10/site-packages/rompy/templates/schismcsiro", "description": "The path to the model template", "title": "Template" }, "checkout": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": "main", "description": "The git branch to use if the template is a git repo", "title": "Checkout" }, "grid": { "$ref": "#/$defs/SCHISMGrid", "description": "The model grid" }, "data": { "$ref": "#/$defs/SCHISMData", "description": "Model inputs" }, "project": { "default": "WAXA", "description": "TODO", "title": "Project", "type": "string" }, "utc_start": { "default": 0, "description": "TODO", "title": "Utc Start", "type": "integer" }, "time_step": { "default": 120.0, "description": "TODO", "title": "Time Step", "type": "number" }, "msc2": { "default": 36, "description": "same as msc in .nml ... for consitency check between SCHISM and WWM", "title": "Msc2", "type": "integer" }, "mdc2": { "default": 36, "description": "same as mdc in .nml", "title": "Mdc2", "type": "integer" }, "ihfskip": { "default": 720, "description": "stack spool; every ihfskip steps will be put into 1_*, 2_*, etc... use 22320.0 for 31 days; 5040 for 7 days; 21600 for 30 days; 20880 for 29 days", "title": "Ihfskip", "type": "number" }, "icou_elfe_wwm": { "default": 1, "description": "If WWM is used, set coupling/decoupling flag. Not used if USE_WWM is distabled in Makefile. 0: decoupled so 2 models will run independently; 1: full coupled (elevation, vel, and wind are all passed to WWM); 2: elevation and currents in wwm, no wave force in SCHISM; 3: no elevation and no currents in wwm, wave force in SCHISM; 4: elevation but no currents in wwm, wave force in SCHISM; 5: elevation but no currents in wwm, no wave force in SCHISM; 6: no elevation but currents in wwm, wave force in SCHISM; 7: no elevation but currents in wwm, no wave force in SCHISM; Note that all these parameters must be present in this file (even though not used).", "title": "Icou Elfe Wwm", "type": "integer" }, "nstep_wwm": { "default": 3, "description": "call WWM every this many time steps. If /=1, consider using quasi-steady mode in WWM", "title": "Nstep Wwm", "type": "integer" }, "deltc": { "default": 360, "description": "TODO", "title": "Deltc", "type": "integer" }, "h1_bcc": { "default": 50.0, "description": "Baroclinicity calculation in off/nearshore with iunder_deep=ibc=0. The 'below-bottom' gradient is zeroed out if h>=h2_bcc (i.e. like Z) or uses const extrap (i.e. like terrain-following) if h<=h1_bcc(<h2_bcc) (and linear transition in between based on local depth)", "title": "H1 Bcc", "type": "number" }, "h2_bcc": { "default": 100.0, "description": "Baroclinicity calculation in off/nearshore with iunder_deep=ibc=0. The 'below-bottom' gradient is zeroed out if h>=h2_bcc (i.e. like Z) or uses const extrap (i.e. like terrain-following) if h<=h1_bcc(<h2_bcc) (and linear transition in between based on local depth)", "title": "H2 Bcc", "type": "number" }, "h_bcc1": { "default": 100.0, "description": "Cut-off depth for cubic spline interpolation near bottom when computing horizontal gradients", "title": "H Bcc1", "type": "number" }, "thetai": { "default": 0.8, "description": "Implicitness factor (0.5<thetai<=1).", "title": "Thetai", "type": "number" }, "iwbl": { "default": 0, "description": "wave boundary layer formulation (used only if USE_WMM and icou_elfe_wwm/=0 and nchi=1. If icou_elfe_wwm=0, set iwbl=0): 1-modified Grant-Madsen formulation; 2-Soulsby (1997)", "title": "Iwbl", "type": "integer" }, "slam0": { "default": 120.0, "description": "Reference latitude for beta-plane approximation when ncor=1 (not used if ics=2)", "title": "Slam0", "type": "number" }, "sfea0": { "default": -29.0, "description": "Reference latitude for beta-plane approximation when ncor=1 (not used if ics=2)", "title": "Sfea0", "type": "number" }, "nchi": { "default": -1, "description": "bottom friction", "title": "Nchi", "type": "integer" }, "dzb_decayYN": { "default": "!", "description": "TODO", "title": "Dzb Decayyn", "type": "string" }, "rlatitude": { "default": -29, "description": "if ncor=-1", "title": "Rlatitude", "type": "number" }, "ic_elev": { "default": 0, "description": "elevation initial condition flag for cold start only", "title": "Ic Elev", "type": "integer" }, "inv_atm_bnd": { "default": 1, "description": "TODO", "title": "Inv Atm Bnd", "type": "integer" }, "ibtrack_openbndYN": { "default": "!", "description": "TODO", "title": "Ibtrack Openbndyn", "type": "string" }, "iwindoffYN": { "default": "!", "description": "TODO", "title": "Iwindoffyn", "type": "string" }, "iwind_form": { "default": 1, "description": "Needed if nws/=0 !usually use -1, trialling -2 to see if makes a difference", "title": "Iwind Form", "type": "integer" }, "sav_cdYN": { "default": "!", "description": "Save current direction (T/F)", "title": "Sav Cdyn", "type": "string" }, "iout_sta": { "default": 0, "description": "Station output option", "title": "Iout Sta", "type": "integer" }, "lindsprdeg": { "default": "F", "description": "Linear interpolation of directional spread (T/F)", "title": "Lindsprdeg", "type": "string" }, "wbdm": { "default": 90, "description": "Wave boundary data mode (1-4)", "title": "Wbdm", "type": "integer" }, "extrapYN": { "default": "!", "description": "Extrapolation of wave boundary data (T/F)", "title": "Extrapyn", "type": "string" }, "extrap": { "default": "T", "description": "Extrapolation of wave boundary data (T/F)", "title": "Extrap", "type": "string" }, "windYN": { "default": "!", "description": "Wind data (T/F)", "title": "Windyn", "type": "string" }, "filewind": { "default": "wind.dat", "description": "Name of the wind data file", "title": "Filewind", "type": "string" }, "currYN": { "default": "!", "description": "Current data (T/F)", "title": "Curryn", "type": "string" }, "walvYN": { "default": "!", "description": "Wave-induced current data (T/F)", "title": "Walvyn", "type": "string" }, "mesin": { "default": 1, "description": "Input message level (0-2)", "title": "Mesin", "type": "integer" }, "mesbf": { "default": 2, "description": "Output message level (0-2)", "title": "Mesbf", "type": "integer" }, "fricc": { "default": 0.11, "description": "Bottom friction factor", "title": "Fricc", "type": "number" }, "ibreak": { "default": 1, "description": "Wave breaking parameterization (1-3)", "title": "Ibreak", "type": "integer" }, "brcrYN": { "default": "", "description": "Wave breaking parameterization (T/F)", "title": "Brcryn", "type": "string" }, "melim": { "default": 1, "description": "Wave energy limit (1-3)", "title": "Melim", "type": "integer" }, "limfak": { "default": 0.1, "description": "Wave energy limit factor", "title": "Limfak", "type": "number" }, "lsourceswam": { "default": "F", "description": "Source term for SWAN (T/F)", "title": "Lsourceswam", "type": "string" }, "deltc_out": { "default": 3600, "description": "Output time step (s)", "title": "Deltc Out", "type": "integer" }, "definetc": { "default": -1, "description": "Definition of output time step (1-3)", "title": "Definetc", "type": "integer" }, "outstyle": { "default": "NC", "description": "Output style (NC/WW3)", "title": "Outstyle", "type": "string" }, "wwm1": { "default": 1, "description": "sig. height (m) {sigWaveHeight} 2D", "title": "Wwm1", "type": "integer" }, "wwm2": { "default": 1, "description": "Mean average period (sec) - TM01 {meanWavePeriod} 2D", "title": "Wwm2", "type": "integer" }, "wwm3": { "default": 0, "description": "Zero down crossing period for comparison with buoy (s) - TM02 {zeroDowncrossPeriod} 2D", "title": "Wwm3", "type": "integer" }, "wwm4": { "default": 0, "description": "Average period of wave runup/overtopping - TM10 {TM10} 2D", "title": "Wwm4", "type": "integer" }, "wwm5": { "default": 0, "description": "Mean wave number (1/m) {meanWaveNumber} 2D", "title": "Wwm5", "type": "integer" }, "wwm6": { "default": 0, "description": "Mean wave length (m) {meanWaveLength} 2D", "title": "Wwm6", "type": "integer" }, "wwm7": { "default": 0, "description": "Mean average energy transport direction (degr) - MWD in NDBC? {meanWaveDirection} 2D", "title": "Wwm7", "type": "integer" }, "wwm8": { "default": 1, "description": "Mean directional spreading (degr) {meanDirSpreading} 2D", "title": "Wwm8", "type": "integer" }, "wwm9": { "default": 1, "description": "Discrete peak period (sec) - Tp {peakPeriod} 2D", "title": "Wwm9", "type": "integer" }, "wwm10": { "default": 0, "description": "Continuous peak period based on higher order moments (sec) {continuousPeakPeriod} 2D", "title": "Wwm10", "type": "integer" }, "wwm11": { "default": 0, "description": "Peak phase vel. (m/s) {peakPhaseVel} 2D", "title": "Wwm11", "type": "integer" }, "wwm12": { "default": 0, "description": "Peak n-factor {peakNFactor} 2D", "title": "Wwm12", "type": "integer" }, "wwm13": { "default": 0, "description": "Peak group vel. (m/s) {peakGroupVel} 2D", "title": "Wwm13", "type": "integer" }, "wwm14": { "default": 0, "description": "Peak wave number {peakWaveNumber} 2D", "title": "Wwm14", "type": "integer" }, "wwm15": { "default": 0, "description": "Peak wave length {peakWaveLength} 2D", "title": "Wwm15", "type": "integer" }, "wwm16": { "default": 1, "description": "Peak (dominant) direction (degr) {dominantDirection} 2D", "title": "Wwm16", "type": "integer" }, "wwm17": { "default": 1, "description": "Peak directional spreading {peakSpreading} 2D", "title": "Wwm17", "type": "integer" }, "wwm18": { "default": 1, "description": "Discrete peak direction (radian?) {discretePeakDirectio} 2D", "title": "Wwm18", "type": "integer" }, "wwm19": { "default": 0, "description": "Orbital vel. (m/s) {orbitalVelocity} 2D", "title": "Wwm19", "type": "integer" }, "wwm20": { "default": 0, "description": "RMS Orbital vel. (m/s) {rmsOrbitalVelocity} 2D", "title": "Wwm20", "type": "integer" }, "wwm21": { "default": 0, "description": "Bottom excursion period (sec?) {bottomExcursionPerio} 2D", "title": "Wwm21", "type": "integer" }, "wwm22": { "default": 0, "description": "Bottom wave period (sec) {bottomWavePeriod} 2D", "title": "Wwm22", "type": "integer" }, "wwm23": { "default": 0, "description": "Uresell number based on peak period {UresellNumber} 2D", "title": "Wwm23", "type": "integer" }, "wwm24": { "default": 0, "description": "Friction velocity (m/s?) {frictionalVelocity} 2D", "title": "Wwm24", "type": "integer" }, "wwm25": { "default": 0, "description": "Charnock coefficient {CharnockCoeff} 2D", "title": "Wwm25", "type": "integer" }, "wwm26": { "default": 0, "description": "Rougness length {rougnessLength} 2D", "title": "Wwm26", "type": "integer" }, "wwm27": { "default": 0, "description": "Roller energy dissipation rate (W/m\u00b2) @nodes {Drol} 2D", "title": "Wwm27", "type": "integer" }, "wwm28": { "default": 0, "description": "Total wave energy dissipation rate by depth-induced breaking (W/m\u00b2) @nodes {wave_sbrtot} 2D", "title": "Wwm28", "type": "integer" }, "wwm29": { "default": 0, "description": "Total wave energy dissipation rate by bottom friction (W/m\u00b2) @nodes {wave_sbftot} 2D", "title": "Wwm29", "type": "integer" }, "wwm30": { "default": 0, "description": "Total wave energy dissipation rate by whitecapping (W/m\u00b2) @nodes {wave_sdstot} 2D", "title": "Wwm30", "type": "integer" }, "wwm31": { "default": 0, "description": "Total wave energy dissipation rate by vegetation (W/m\u00b2) @nodes {wave_svegtot} 2D", "title": "Wwm31", "type": "integer" }, "wwm32": { "default": 0, "description": "Total wave energy input rate from atmospheric forcing (W/m\u00b2) @nodes {wave_sintot} 2D", "title": "Wwm32", "type": "integer" }, "wwm33": { "default": 0, "description": "WWM_energy vector {waveEnergyDirX,Y} 2D vector", "title": "Wwm33", "type": "integer" }, "wwm34": { "default": 0, "description": "Vertical Stokes velocity (m.s-1) @sides and whole levels {stokes_wvel} 3D", "title": "Wwm34", "type": "integer" }, "wwm35": { "default": 0, "description": "Wave force vector (m.s-2) computed by wwm @side centers and whole levels {waveForceX,Y} 3D vector", "title": "Wwm35", "type": "integer" }, "wwm36": { "default": 0, "description": "Horizontal Stokes velocity (m.s-1) @nodes and whole levels {stokes_hvel} 3D vector", "title": "Wwm36", "type": "integer" }, "wwm37": { "default": 0, "description": "Roller contribution to horizontal Stokes velocity (m.s-1) @nodes and whole levels {roller_stokes_hvel} 3D vector", "title": "Wwm37", "type": "integer" }, "wwm31YN": { "default": "!", "description": "Total wave energy dissipation rate by vegetation (W/m2) @nodes {wave_svegtot} 2D", "title": "Wwm31Yn", "type": "string" }, "wwm32YN": { "default": "!", "description": "Total wave energy input rate from atmospheric forcing (W/m2) @nodes {wave_sintot} 2D", "title": "Wwm32Yn", "type": "string" }, "wwm33YN": { "default": "!", "description": "WWM_energy vector {waveEnergyDirX,Y} 2D vector", "title": "Wwm33Yn", "type": "string" }, "wwm34YN": { "default": "!", "description": "Vertical Stokes velocity (m.s-1) @sides and whole levels {stokes_wvel} 3D", "title": "Wwm34Yn", "type": "string" }, "wwm35YN": { "default": "!", "description": "Wave force vector (m.s-2) computed by wwm @side centers and whole levels {waveForceX,Y} 3D vector", "title": "Wwm35Yn", "type": "string" }, "wwm36YN": { "default": "!", "description": "Horizontal Stokes velocity (m.s-1) @nodes and whole levels {stokes_hvel} 3D vector", "title": "Wwm36Yn", "type": "string" }, "wwm37YN": { "default": "!", "description": "Roller contribution to horizontal Stokes velocity (m.s-1) @nodes and whole levels {roller_stokes_hvel} 3D vector ", "title": "Wwm37Yn", "type": "string" }, "HS": { "default": "T", "description": "significant wave height", "title": "Hs", "type": "string" }, "TM01": { "default": "T", "description": "mean period", "title": "Tm01", "type": "string" }, "TM02": { "default": "F", "description": "zero-crossing mean period", "title": "Tm02", "type": "string" }, "DM": { "default": "T", "description": "mean wave direction", "title": "Dm", "type": "string" }, "DSPR": { "default": "T", "description": "directional spreading", "title": "Dspr", "type": "string" }, "TPP": { "default": "T", "description": "peak period", "title": "Tpp", "type": "string" }, "TPPD": { "default": "T", "description": "direaction of the peak ... check source code", "title": "Tppd", "type": "string" }, "CPP": { "default": "F", "description": "peak phase velocity", "title": "Cpp", "type": "string" }, "WNPP": { "default": "F", "description": "peak wave number", "title": "Wnpp", "type": "string" }, "CGPP": { "default": "F", "description": "peak group speed", "title": "Cgpp", "type": "string" }, "KPP": { "default": "F", "description": "peak wave number", "title": "Kpp", "type": "string" }, "LPP": { "default": "F", "description": "peak wave length", "title": "Lpp", "type": "string" }, "PEAKD": { "default": "T", "description": "peak direction", "title": "Peakd", "type": "string" }, "DPEAK": { "default": "T", "description": "peak direction", "title": "Dpeak", "type": "string" }, "PEAKDSPR": { "default": "T", "description": "peak directional spreading", "title": "Peakdspr", "type": "string" }, "UBOT": { "default": "F", "description": "bottom exc. velocity", "title": "Ubot", "type": "string" }, "ORBITAL": { "default": "F", "description": "bottom orbital velocity", "title": "Orbital", "type": "string" }, "iouts": { "default": 15, "title": "Iouts", "type": "string" }, "nouts": { "default": "'AWAC_in','AWAC_mid','AWAC_off','SPOT_1002','SPOT_1011','SPOT_1018','SPOT_1026'", "description": "TODO", "title": "Nouts", "type": "string" }, "xouts": { "default": "115.6208687,115.5941886,115.58077,115.5942931,115.5830497,115.5807825,115.5960683", "description": "TODO", "title": "Xouts", "type": "string" }, "youts": { "default": "-32.611605,-32.611605,-32.613682,-32.6253914,-32.6135870,-32.6294226,-32.6096741", "description": "TODO", "title": "Youts", "type": "string" }, "lsp2d": { "default": "T", "description": "TODO", "title": "Lsp2D", "type": "string" }, "ac": { "default": "T", "description": "TODO", "title": "Ac", "type": "string" }, "drampwafo": { "default": 1.0, "description": "TODO", "title": "Drampwafo", "type": "number" }, "nadv": { "default": 1, "description": "TODO", "title": "Nadv", "type": "integer" }, "drampwind": { "default": 1.0, "description": "TODO", "title": "Drampwind", "type": "number" }, "dramp": { "default": 1.0, "description": "TODO", "title": "Dramp", "type": "number" }, "wwminput_history_DEP": { "default": "F", "description": "TODO", "title": "Wwminput History Dep", "type": "string" }, "wwminput_history_TAUW": { "default": "F", "description": "TODO", "title": "Wwminput History Tauw", "type": "string" }, "wwminput_history_TAUHF": { "default": "T", "description": "TODO", "title": "Wwminput History Tauhf", "type": "string" }, "wwminput_history_TAUTOT": { "default": "T", "description": "TODO", "title": "Wwminput History Tautot", "type": "string" }, "wwminput_history_STOKESSURFX": { "default": "T", "description": "TODO", "title": "Wwminput History Stokessurfx", "type": "string" }, "wwminput_history_STOKESSURFY": { "default": "T", "description": "TODO", "title": "Wwminput History Stokessurfy", "type": "string" }, "wwminput_history_STOKESBAROX": { "default": "T", "description": "TODO", "title": "Wwminput History Stokesbarox", "type": "string" }, "wwminput_history_STOKESBAROY": { "default": "T", "description": "TODO", "title": "Wwminput History Stokesbaroy", "type": "string" }, "wwminput_station_DEP": { "default": "T", "description": "TODO", "title": "Wwminput Station Dep", "type": "string" }, "wwminput_station_TAUW": { "default": "T", "description": "TODO", "title": "Wwminput Station Tauw", "type": "string" }, "wwminput_station_TAUHF": { "default": "T", "description": "TODO", "title": "Wwminput Station Tauhf", "type": "string" }, "wwminput_station_TAUTOT": { "default": "T", "description": "TODO", "title": "Wwminput Station Tautot", "type": "string" }, "wwminput_station_STOKESSURFX": { "default": "T", "description": "TODO", "title": "Wwminput Station Stokessurfx", "type": "string" }, "wwminput_station_STOKESSURFY": { "default": "T", "description": "TODO", "title": "Wwminput Station Stokessurfy", "type": "string" }, "wwminput_station_STOKESBAROX": { "default": "T", "description": "TODO", "title": "Wwminput Station Stokesbarox", "type": "string" }, "wwminput_station_STOKESBAROY": { "default": "T", "description": "TODO", "title": "Wwminput Station Stokesbaroy", "type": "string" }, "wwminput_station_OUTSTYLE": { "default": "NO", "description": "'NO' no output 'STE' classic station output (default) 'NC' for netcdf output", "title": "Wwminput Station Outstyle", "type": "string" }, "wwminput_LHOTF": { "default": "F", "description": "wwminput Write hotfile", "title": "Wwminput Lhotf", "type": "string" }, "param_nhot": { "default": 0, "description": "use 1 to write out hotstart: output *_hotstart every 'hotout_write' steps", "title": "Param Nhot", "type": "integer" }, "param_nhot_writeYN": { "default": "!", "description": "enables or disables (!) the nhot write field", "title": "Param Nhot Writeyn", "type": "string" }, "param_nhot_write": { "default": 22320.0, "description": "if enabled when nhot and nhotwriteYN enabled then must be a multiple of ihfskip if nhot=1", "title": "Param Nhot Write", "type": "number" }, "wwminput_LHOTR": { "default": "F", "description": "Use hotstart file (see &HOTFILE section)", "title": "Wwminput Lhotr", "type": "string" }, "wwminput_LINID": { "default": "T", "description": " Initial condition; F for default; use T if using WW3 as i.c. etc", "title": "Wwminput Linid", "type": "string" }, "param_iof_hydro1": { "default": 1, "description": "output 0: off; 1: on - elev. [m] {elev} 2D - Default 1", "title": "Param Iof Hydro1", "type": "integer" }, "param_iof_hydro2": { "default": 0, "description": "output 0: off; 1: on - air pressure [Pa] {air_pressure} 2D - Default 0", "title": "Param Iof Hydro2", "type": "integer" }, "param_iof_hydro3": { "default": 0, "description": "output 0: off; 1: on - air temperature [C] {air_temperature} 2D - Default 0", "title": "Param Iof Hydro3", "type": "integer" }, "param_iof_hydro4": { "default": 0, "description": "output 0: off; 1: on - Specific humidity [-] {specific_humidity} 2D - Default 0", "title": "Param Iof Hydro4", "type": "integer" }, "param_iof_hydro5": { "default": 0, "description": "output 0: off; 1: on - solar (shortwave) radiation [W/m/m] {solar_radiation} 2D - Default 0", "title": "Param Iof Hydro5", "type": "integer" }, "param_iof_hydro6": { "default": 0, "description": "output 0: off; 1: on - sensible flux (positive upward) [W/m/m] {sensible_flux} 2D - Default 0", "title": "Param Iof Hydro6", "type": "integer" }, "param_iof_hydro7": { "default": 0, "description": "output 0: off; 1: on - latent heat flux (positive upward) [W/m/m] {latent_heat} 2D - Default 0", "title": "Param Iof Hydro7", "type": "integer" }, "param_iof_hydro8": { "default": 0, "description": "output 0: off; 1: on - upward longwave radiation (positive upward) [W/m/m] {upward_longwave} 2D - Default 0", "title": "Param Iof Hydro8", "type": "integer" }, "param_iof_hydro9": { "default": 0, "description": "output 0: off; 1: on - downward longwave radiation (positive downward) [W/m/m] {downward_longwave} 2D - Default 0", "title": "Param Iof Hydro9", "type": "integer" }, "param_iof_hydro10": { "default": 0, "description": "output 0: off; 1: on - total flux=-flsu-fllu-(radu-radd) [W/m/m] {total_heat_flux} 2D - Default 0", "title": "Param Iof Hydro10", "type": "integer" }, "param_iof_hydro11": { "default": 0, "description": "output 0: off; 1: on - evaporation rate [kg/m/m/s] {evaporation} 2D - Default 0", "title": "Param Iof Hydro11", "type": "integer" }, "param_iof_hydro12": { "default": 0, "description": "output 0: off; 1: on - precipitation rate [kg/m/m/s] {precipitation} 2D - Default 0", "title": "Param Iof Hydro12", "type": "integer" }, "param_iof_hydro13": { "default": 0, "description": "output 0: off; 1: on - Bottom stress vector [kg/m/s^2(Pa)] {bottom_stress} 2D vector - Default 0", "title": "Param Iof Hydro13", "type": "integer" }, "param_iof_hydro14": { "default": 0, "description": "output 0: off; 1: on - wind velocity vector [m/s] {wind_speed} 2D vector - Default 0", "title": "Param Iof Hydro14", "type": "integer" }, "param_iof_hydro15": { "default": 0, "description": "output 0: off; 1: on - wind stress vector [m^2/s/s] {wind_stress} 2D vector - Default 0", "title": "Param Iof Hydro15", "type": "integer" }, "param_iof_hydro16": { "default": 1, "description": "output 0: off; 1: on - depth-averaged vel vector [m/s] {dahv} 2D vector - Default 1", "title": "Param Iof Hydro16", "type": "integer" }, "param_iof_hydro17": { "default": 0, "description": "output 0: off; 1: on - vertical velocity [m/s] {vertical_velocity} 3D - Default 0", "title": "Param Iof Hydro17", "type": "integer" }, "param_iof_hydro18": { "default": 0, "description": "output 0: off; 1: on - water temperature [C] {temp} 3D - Default 0", "title": "Param Iof Hydro18", "type": "integer" }, "param_iof_hydro19": { "default": 0, "description": "output 0: off; 1: on - water salinity [PSU] {salt} 3D - Default 0", "title": "Param Iof Hydro19", "type": "integer" }, "param_iof_hydro20": { "default": 0, "description": "output 0: off; 1: on - water density [kg/m^3] {water_density} 3D - Default 0", "title": "Param Iof Hydro20", "type": "integer" }, "param_iof_hydro21": { "default": 0, "description": "output 0: off; 1: on - eddy diffusivity [m^2/s] {diffusivity} 3D - Default 0", "title": "Param Iof Hydro21", "type": "integer" }, "param_iof_hydro22": { "default": 0, "description": "output 0: off; 1: on - eddy viscosity [m^2/s] {viscosity} 3D - Default 0", "title": "Param Iof Hydro22", "type": "integer" }, "param_iof_hydro23": { "default": 0, "description": "output 0: off; 1: on - turbulent kinetic energy {TKE} 3D - Default 0", "title": "Param Iof Hydro23", "type": "integer" }, "param_iof_hydro24": { "default": 0, "description": "output 0: off; 1: on - turbulent mixing length [m] {mixing_length} 3D - Default 0", "title": "Param Iof Hydro24", "type": "integer" }, "param_iof_hydro25": { "default": 0, "description": "output 0: off; 1: on - horizontal vel vector [m/s] {hvel} 3D vector - Default 0", "title": "Param Iof Hydro25", "type": "integer" }, "param_iof_hydro26": { "default": 0, "description": "output 0: off; 1: on - horizontal vel vector defined @side [m/s] {hvel_side} 3D vector - Default 0", "title": "Param Iof Hydro26", "type": "integer" }, "param_iof_hydro27": { "default": 0, "description": "output 0: off; 1: on - vertical vel. @elem [m/s] {wvel_elem} 3D vector - Default 0", "title": "Param Iof Hydro27", "type": "integer" }, "param_iof_hydro28": { "default": 0, "description": "output 0: off; 1: on - T @prism centers [C] {temp_elem} 3D - Default 0", "title": "Param Iof Hydro28", "type": "integer" }, "param_iof_hydro29": { "default": 0, "description": "output 0: off; 1: on - S @prism centers [PSU] {salt_elem} 3D - Default 0", "title": "Param Iof Hydro29", "type": "integer" }, "param_iof_hydro30": { "default": 0, "description": "output 0: off; 1: on - Barotropic pressure gradient force vector (m.s-2) @side centers {pressure_gradient} 2D vector - Default 0", "title": "Param Iof Hydro30", "type": "integer" }, "wwminput_history_OUTSTYLE": { "default": "NC", "description": "'output option - use 'NO' for no output", "title": "Wwminput History Outstyle", "type": "string" }, "param_nspool_sta": { "default": 30, "description": "needed if iout_sta/=0; mod(nhot_write,nspool_sta) must=0 defaults to 30", "title": "Param Nspool Sta", "type": "integer" }, "ihot": { "default": 0, "description": "hotstart 0: off; 1: on - whether to expect hotstarts - Default - 0-", "title": "Ihot", "type": "integer" }, "wwminput_hotfile_DELTC": { "default": 0, "description": "hotfile time in UNITC (typically seconds) when hotfile should be written, defaults to 3600", "title": "Wwminput Hotfile Deltc", "type": "integer" }, "wwminput_station_DELTC": { "default": 3600, "description": "Time step for output; if smaller than simulation time step, the latter is used (output every step for better 1D 2D spectra analysis)", "title": "Wwminput Station Deltc", "type": "integer" }, "wwminput_history_DELTC": { "default": 3600, "description": "Time step for output; if smaller than simulation time step, the latter is used (output every step for better 1D 2D spectra analysis)", "title": "Wwminput History Deltc", "type": "integer" } }, "$defs": { "DataBlob": { "additionalProperties": false, "description": "Data source for model ingestion.\n\nGeneric data source for files that either need to be copied to the model directory\nor linked if `link` is set to True.", "properties": { "model_type": { "default": "data_blob", "description": "Model type discriminator", "enum": [ "data_blob", "data_link" ], "title": "Model Type", "type": "string" }, "id": { "default": "data", "description": "Unique identifier for this data source", "title": "Id", "type": "string" }, "source": { "description": "URI of the data source, either a local file path or a remote uri", "title": "Source" }, "link": { "default": false, "description": "Whether to create a symbolic link instead of copying the file", "title": "Link", "type": "boolean" } }, "required": [ "source" ], "title": "DataBlob", "type": "object" }, "DatasetCoords": { "additionalProperties": false, "description": "Coordinates representation.", "properties": { "t": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": "time", "description": "Name of the time coordinate", "title": "T" }, "x": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": "longitude", "description": "Name of the x coordinate", "title": "X" }, "y": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": "latitude", "description": "Name of the y coordinate", "title": "Y" }, "z": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": "depth", "description": "Name of the z coordinate", "title": "Z" }, "s": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": "site", "description": "Name of the site coordinate", "title": "S" } }, "title": "DatasetCoords", "type": "object" }, "Filter": { "additionalProperties": false, "properties": { "sort": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": {}, "title": "Sort" }, "subset": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": {}, "title": "Subset" }, "crop": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": {}, "title": "Crop" }, "timenorm": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": {}, "title": "Timenorm" }, "rename": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": {}, "title": "Rename" }, "derived": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": {}, "title": "Derived" } }, "title": "Filter", "type": "object" }, "GR3Generator": { "additionalProperties": false, "properties": { "model_type": { "const": "gr3_generator", "default": "gr3_generator", "description": "Model discriminator", "title": "Model Type", "type": "string" }, "hgrid": { "anyOf": [ { "$ref": "#/$defs/DataBlob" }, { "format": "path", "type": "string" } ], "description": "Path to hgrid.gr3 file", "title": "Hgrid" }, "gr3_type": { "description": "Type of gr3 file. Must be one of 'albedo', 'diffmin', 'diffmax', 'watertype', 'windrot_geo2proj'", "title": "Gr3 Type", "type": "string" }, "value": { "default": null, "description": "Constant value to set in gr3 file", "title": "Value", "type": "number" }, "crs": { "default": "epsg:4326", "description": "Coordinate reference system", "title": "Crs", "type": "string" } }, "required": [ "hgrid", "gr3_type" ], "title": "GR3Generator", "type": "object" }, "GridLinker": { "additionalProperties": false, "properties": { "hgrid": { "anyOf": [ { "$ref": "#/$defs/DataBlob" }, { "format": "path", "type": "string" } ], "description": "Path to hgrid.gr3 file", "title": "Hgrid" }, "gridtype": { "description": "Type of grid to link", "title": "Gridtype", "type": "string" } }, "required": [ "hgrid", "gridtype" ], "title": "GridLinker", "type": "object" }, "SCHISMData": { "additionalProperties": false, "description": "This class is used to gather all required input forcing for SCHISM", "properties": { "data_type": { "const": "schism", "default": "schism", "description": "Model type discriminator", "title": "Data Type", "type": "string" }, "atmos": { "anyOf": [ { "$ref": "#/$defs/SCHISMDataSflux" }, { "type": "null" } ], "default": null, "description": "atmospheric data" }, "ocean": { "anyOf": [ { "$ref": "#/$defs/SCHISMDataOcean" }, { "type": "null" } ], "default": null, "description": "ocean data" }, "wave": { "anyOf": [ { "$ref": "#/$defs/DataBlob" }, { "$ref": "#/$defs/SCHISMDataWave" }, { "type": "null" } ], "default": null, "description": "wave data", "title": "Wave" }, "tides": { "anyOf": [ { "$ref": "#/$defs/DataBlob" }, { "$ref": "#/$defs/SCHISMDataTides" }, { "type": "null" } ], "default": null, "description": "tidal data", "title": "Tides" } }, "title": "SCHISMData", "type": "object" }, "SCHISMDataBoundary": { "additionalProperties": false, "description": "This class is used to extract ocean boundary data from a griddd dataset at all open\nboundary nodes.", "properties": { "model_type": { "const": "boundary", "default": "data_boundary", "description": "Model type discriminator", "title": "Model Type", "type": "string" }, "id": { "choices": [ "elev2D", "uv3D", "TEM_3D", "SAL_3D", "bnd" ], "default": "bnd", "description": "SCHISM th id of the source", "title": "Id", "type": "string" }, "source": { "description": "Source reader, must return an xarray gridded dataset in the open method", "discriminator": { "mapping": { "csv": "#/$defs/SourceTimeseriesCSV", "datamesh": "#/$defs/SourceDatamesh", "file": "#/$defs/SourceFile", "intake": "#/$defs/SourceIntake", "wavespectra": "#/$defs/SourceWavespectra" }, "propertyName": "model_type" }, "oneOf": [ { "$ref": "#/$defs/SourceTimeseriesCSV" }, { "$ref": "#/$defs/SourceDatamesh" }, { "$ref": "#/$defs/SourceFile" }, { "$ref": "#/$defs/SourceIntake" }, { "$ref": "#/$defs/SourceWavespectra" } ], "title": "Source" }, "link": { "default": false, "description": "Whether to create a symbolic link instead of copying the file", "title": "Link", "type": "boolean" }, "filter": { "anyOf": [ { "$ref": "#/$defs/Filter" }, { "type": "null" } ], "description": "Optional filter specification to apply to the dataset" }, "variables": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": [], "description": "Subset of variables to extract from the dataset", "title": "Variables" }, "coords": { "anyOf": [ { "$ref": "#/$defs/DatasetCoords" }, { "type": "null" } ], "default": { "t": "time", "x": "longitude", "y": "latitude", "z": "depth", "s": "site" }, "description": "Names of the coordinates in the dataset" }, "crop_data": { "default": true, "description": "Update crop filter from Time object if passed to get method", "title": "Crop Data", "type": "boolean" }, "buffer": { "default": 0.0, "description": "Space to buffer the grid bounding box if `filter_grid` is True", "title": "Buffer", "type": "number" }, "time_buffer": { "default": [ 0, 1 ], "description": "Number of source data timesteps to buffer the time range if `filter_time` is True", "items": { "type": "integer" }, "title": "Time Buffer", "type": "array" }, "spacing": { "anyOf": [ { "type": "number" }, { "const": "parent", "type": "string" }, { "type": "null" } ], "default": null, "description": "Spacing between points along the grid boundary to retrieve data for. If None (default), points are defined from the the actual grid object passed to the `get` method. If 'parent', the resolution of the parent dataset is used to define the spacing.", "title": "Spacing" }, "sel_method": { "default": "interp", "description": "Xarray method to use for selecting boundary points from the dataset", "enum": [ "sel", "interp" ], "title": "Sel Method", "type": "string" }, "sel_method_kwargs": { "additionalProperties": true, "default": {}, "description": "Keyword arguments for sel_method", "title": "Sel Method Kwargs", "type": "object" }, "data_type": { "const": "boundary", "default": "boundary", "description": "Model type discriminator", "title": "Data Type", "type": "string" }, "variable": { "description": "variable name in the dataset", "title": "Variable", "type": "string" }, "interpolate_missing_coastal": { "default": true, "description": "interpolate_missing coastal data points", "title": "Interpolate Missing Coastal", "type": "boolean" } }, "required": [ "source", "variable" ], "title": "SCHISMDataBoundary", "type": "object" }, "SCHISMDataOcean": { "additionalProperties": false, "description": "This class is used define all ocean boundary forcing", "properties": { "data_type": { "const": "ocean", "default": "ocean", "description": "Model type discriminator", "title": "Data Type", "type": "string" }, "elev2D": { "anyOf": [ { "$ref": "#/$defs/DataBlob" }, { "$ref": "#/$defs/SCHISMDataBoundary" }, { "type": "null" } ], "default": null, "description": "elev2D", "title": "Elev2D" }, "uv3D": { "anyOf": [ { "$ref": "#/$defs/DataBlob" }, { "$ref": "#/$defs/SCHISMDataBoundary" }, { "type": "null" } ], "default": null, "description": "uv3D", "title": "Uv3D" }, "TEM_3D": { "anyOf": [ { "$ref": "#/$defs/DataBlob" }, { "$ref": "#/$defs/SCHISMDataBoundary" }, { "type": "null" } ], "default": null, "description": "TEM_3D", "title": "Tem 3D" }, "SAL_3D": { "anyOf": [ { "$ref": "#/$defs/DataBlob" }, { "$ref": "#/$defs/SCHISMDataBoundary" }, { "type": "null" } ], "default": null, "description": "SAL_3D", "title": "Sal 3D" } }, "title": "SCHISMDataOcean", "type": "object" }, "SCHISMDataSflux": { "additionalProperties": false, "properties": { "data_type": { "const": "sflux", "default": "sflux", "description": "Model type discriminator", "title": "Data Type", "type": "string" }, "air_1": { "anyOf": [ { "$ref": "#/$defs/DataBlob" }, { "$ref": "#/$defs/SfluxAir" }, { "type": "null" } ], "default": null, "description": "sflux air source 1", "title": "Air 1" }, "air_2": { "anyOf": [ { "$ref": "#/$defs/DataBlob" }, { "$ref": "#/$defs/SfluxAir" }, { "type": "null" } ], "default": null, "description": "sflux air source 2", "title": "Air 2" }, "rad_1": { "anyOf": [ { "$ref": "#/$defs/DataBlob" }, { "$ref": "#/$defs/SfluxRad" }, { "type": "null" } ], "default": null, "description": "sflux rad source 1", "title": "Rad 1" }, "rad_2": { "anyOf": [ { "$ref": "#/$defs/DataBlob" }, { "$ref": "#/$defs/SfluxRad" }, { "type": "null" } ], "default": null, "description": "sflux rad source 2", "title": "Rad 2" }, "prc_1": { "anyOf": [ { "$ref": "#/$defs/DataBlob" }, { "$ref": "#/$defs/SfluxPrc" }, { "type": "null" } ], "default": null, "description": "sflux prc source 1", "title": "Prc 1" }, "prc_2": { "anyOf": [ { "$ref": "#/$defs/DataBlob" }, { "$ref": "#/$defs/SfluxPrc" }, { "type": "null" } ], "default": null, "description": "sflux prc source 2", "title": "Prc 2" } }, "title": "SCHISMDataSflux", "type": "object" }, "SCHISMDataTides": { "additionalProperties": false, "description": "This class is used to define the tidal forcing for SCHISM.", "properties": { "data_type": { "const": "tides", "default": "tide", "description": "Model type discriminator", "title": "Data Type", "type": "string" }, "tidal_data": { "$ref": "#/$defs/TidalDataset", "description": "tidal dataset" }, "cutoff_depth": { "default": 50.0, "description": "cutoff depth for tides", "title": "Cutoff Depth", "type": "number" }, "flags": { "anyOf": [ { "items": {}, "type": "array" }, { "type": "null" } ], "default": [ [ 5, 3, 0, 0 ] ], "description": "nested list of bctypes", "title": "Flags" }, "constituents": { "anyOf": [ { "type": "string" }, { "items": {}, "type": "array" } ], "default": "major", "description": "constituents", "title": "Constituents" }, "database": { "choices": [ "tpxo", "fes2014" ], "default": "tpxo", "description": "database", "title": "Database", "type": "string" }, "add_earth_tidal": { "default": true, "description": "add_earth_tidal", "title": "Add Earth Tidal", "type": "boolean" }, "ethconst": { "anyOf": [ { "items": {}, "type": "array" }, { "type": "null" } ], "default": [], "description": "constant elevation value for each open boundary", "title": "Ethconst" }, "vthconst": { "anyOf": [ { "items": {}, "type": "array" }, { "type": "null" } ], "default": [], "description": "constant discharge value for each open boundary", "title": "Vthconst" }, "tthconst": { "anyOf": [ { "items": {}, "type": "array" }, { "type": "null" } ], "default": [], "description": "constant temperature value for each open boundary", "title": "Tthconst" }, "sthconst": { "anyOf": [ { "items": {}, "type": "array" }, { "type": "null" } ], "default": [], "description": "constant salinity value for each open boundary", "title": "Sthconst" }, "tobc": { "anyOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": [ 1 ], "description": "nuding factor of temperature for each open boundary", "title": "Tobc" }, "sobc": { "anyOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": [ 1 ], "description": "nuding factor of salinity for each open boundary", "title": "Sobc" }, "relax": { "anyOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": [], "description": "relaxation constants for inflow and outflow", "title": "Relax" } }, "required": [ "tidal_data" ], "title": "SCHISMDataTides", "type": "object" }, "SCHISMDataWave": { "additionalProperties": false, "description": "This class is used to write wave spectral boundary data. Spectral data is extracted\nfrom the nearest points along the grid boundary", "properties": { "model_type": { "const": "boundary", "default": "data_boundary", "description": "Model type discriminator", "title": "Model Type", "type": "string" }, "id": { "description": "Unique identifier for this data source", "title": "Id", "type": "string" }, "source": { "description": "Dataset source reader, must return a wavespectra-enabled xarray dataset in the open method", "discriminator": { "mapping": { "csv": "#/$defs/SourceTimeseriesCSV", "datamesh": "#/$defs/SourceDatamesh", "file": "#/$defs/SourceFile", "intake": "#/$defs/SourceIntake", "wavespectra": "#/$defs/SourceWavespectra" }, "propertyName": "model_type" }, "oneOf": [ { "$ref": "#/$defs/SourceTimeseriesCSV" }, { "$ref": "#/$defs/SourceDatamesh" }, { "$ref": "#/$defs/SourceFile" }, { "$ref": "#/$defs/SourceIntake" }, { "$ref": "#/$defs/SourceWavespectra" } ], "title": "Source" }, "link": { "default": false, "description": "Whether to create a symbolic link instead of copying the file", "title": "Link", "type": "boolean" }, "filter": { "anyOf": [ { "$ref": "#/$defs/Filter" }, { "type": "null" } ], "description": "Optional filter specification to apply to the dataset" }, "variables": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": [], "description": "Subset of variables to extract from the dataset", "title": "Variables" }, "coords": { "anyOf": [ { "$ref": "#/$defs/DatasetCoords" }, { "type": "null" } ], "default": { "t": "time", "x": "longitude", "y": "latitude", "z": "depth", "s": "site" }, "description": "Names of the coordinates in the dataset" }, "crop_data": { "default": true, "description": "Update crop filter from Time object if passed to get method", "title": "Crop Data", "type": "boolean" }, "buffer": { "default": 2.0, "description": "Space to buffer the grid bounding box if `filter_grid` is True", "title": "Buffer", "type": "number" }, "time_buffer": { "default": [ 0, 1 ], "description": "Number of source data timesteps to buffer the time range if `filter_time` is True", "items": { "type": "integer" }, "title": "Time Buffer", "type": "array" }, "spacing": { "anyOf": [ { "type": "number" }, { "const": "parent", "type": "string" }, { "type": "null" } ], "default": null, "description": "Spacing between points along the grid boundary to retrieve data for. If None (default), points are defined from the the actual grid object passed to the `get` method. If 'parent', the resolution of the parent dataset is used to define the spacing.", "title": "Spacing" }, "sel_method": { "additionalProperties": true, "default": "nearest", "description": "Keyword arguments for sel_method", "title": "Sel Method", "type": "object" }, "sel_method_kwargs": { "additionalProperties": true, "default": { "unique": true }, "description": "Keyword arguments for sel_method", "title": "Sel Method Kwargs", "type": "object" }, "grid_type": { "const": "boundary_wave_station", "default": "boundary_wave_station", "description": "Model type discriminator", "title": "Grid Type", "type": "string" }, "data_type": { "const": "wave", "default": "wave", "description": "Model type discriminator", "title": "Data Type", "type": "string" } }, "required": [ "id", "source" ], "title": "SCHISMDataWave", "type": "object" }, "SCHISMGrid": { "additionalProperties": false, "description": "SCHISM grid in geographic space.", "properties": { "grid_type": { "const": "schism", "default": "schism", "description": "Model descriminator", "title": "Grid Type", "type": "string" }, "hgrid": { "$ref": "#/$defs/DataBlob", "description": "Path to hgrid.gr3 file" }, "vgrid": { "anyOf": [ { "$ref": "#/$defs/DataBlob" }, { "$ref": "#/$defs/VgridGenerator" }, { "type": "null" } ], "default": null, "description": "Path to vgrid.in file", "title": "Vgrid" }, "drag": { "anyOf": [ { "$ref": "#/$defs/DataBlob" }, { "type": "number" }, { "$ref": "#/$defs/GR3Generator" }, { "type": "null" } ], "default": null, "description": "Path to drag.gr3 file", "title": "Drag" }, "rough": { "anyOf": [ { "$ref": "#/$defs/DataBlob" }, { "type": "number" }, { "$ref": "#/$defs/GR3Generator" }, { "type": "null" } ], "default": null, "description": "Path to rough.gr3 file", "title": "Rough" }, "manning": { "anyOf": [ { "$ref": "#/$defs/DataBlob" }, { "type": "number" }, { "$ref": "#/$defs/GR3Generator" }, { "type": "null" } ], "default": null, "description": "Path to manning.gr3 file", "title": "Manning" }, "hgridll": { "anyOf": [ { "$ref": "#/$defs/DataBlob" }, { "type": "integer" }, { "$ref": "#/$defs/GridLinker" }, { "type": "null" } ], "default": null, "description": "Path to hgrid.ll file", "title": "Hgridll" }, "diffmin": { "anyOf": [ { "$ref": "#/$defs/DataBlob" }, { "type": "number" }, { "$ref": "#/$defs/GR3Generator" }, { "type": "null" } ], "default": 1e-06, "description": "Path to diffmax.gr3 file or constant value", "title": "Diffmin" }, "diffmax": { "anyOf": [ { "$ref": "#/$defs/DataBlob" }, { "type": "number" }, { "$ref": "#/$defs/GR3Generator" }, { "type": "null" } ], "default": 1.0, "description": "Path to diffmax.gr3 file or constant value", "title": "Diffmax" }, "albedo": { "anyOf": [ { "$ref": "#/$defs/DataBlob" }, { "type": "number" }, { "$ref": "#/$defs/GR3Generator" }, { "type": "null" } ], "default": 0.15, "description": "Path to albedo.gr3 file or constant value", "title": "Albedo" }, "watertype": { "anyOf": [ { "$ref": "#/$defs/DataBlob" }, { "type": "integer" }, { "$ref": "#/$defs/GR3Generator" }, { "type": "null" } ], "default": 1, "description": "Path to watertype.gr3 file or constant value", "title": "Watertype" }, "windrot_geo2proj": { "anyOf": [ { "$ref": "#/$defs/DataBlob" }, { "type": "number" }, { "$ref": "#/$defs/GR3Generator" }, { "type": "null" } ], "default": 0.0, "description": "Path to windrot_geo2proj.gr3 file or constant value", "title": "Windrot Geo2Proj" }, "hgrid_WWM": { "anyOf": [ { "$ref": "#/$defs/DataBlob" }, { "$ref": "#/$defs/GridLinker" }, { "type": "null" } ], "default": null, "description": "Path to hgrid_WWM.gr3 file", "title": "Hgrid Wwm" }, "wwmbnd": { "anyOf": [ { "$ref": "#/$defs/DataBlob" }, { "$ref": "#/$defs/WWMBNDGR3Generator" }, { "type": "null" } ], "default": null, "description": "Path to wwmbnd.gr3 file", "title": "Wwmbnd" }, "crs": { "default": "epsg:4326", "description": "Coordinate reference system", "title": "Crs", "type": "string" } }, "required": [ "hgrid" ], "title": "SCHISMGrid", "type": "object" }, "SfluxAir": { "additionalProperties": false, "description": "This is a single variable source for and sflux input", "properties": { "model_type": { "const": "grid", "default": "grid", "description": "Model type discriminator", "title": "Model Type", "type": "string" }, "id": { "choices": [ "air", "rad", "prc" ], "default": null, "description": "id of the source", "title": "Id", "type": "string" }, "source": { "description": "Source reader, must return an xarray gridded dataset in the open method", "discriminator": { "mapping": { "csv": "#/$defs/SourceTimeseriesCSV", "datamesh": "#/$defs/SourceDatamesh", "file": "#/$defs/SourceFile", "intake": "#/$defs/SourceIntake", "wavespectra": "#/$defs/SourceWavespectra" }, "propertyName": "model_type" }, "oneOf": [ { "$ref": "#/$defs/SourceTimeseriesCSV" }, { "$ref": "#/$defs/SourceDatamesh" }, { "$ref": "#/$defs/SourceFile" }, { "$ref": "#/$defs/SourceIntake" }, { "$ref": "#/$defs/SourceWavespectra" } ], "title": "Source" }, "link": { "default": false, "description": "Whether to create a symbolic link instead of copying the file", "title": "Link", "type": "boolean" }, "filter": { "anyOf": [ { "$ref": "#/$defs/Filter" }, { "type": "null" } ], "description": "Optional filter specification to apply to the dataset" }, "variables": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": [], "description": "Subset of variables to extract from the dataset", "title": "Variables" }, "coords": { "anyOf": [ { "$ref": "#/$defs/DatasetCoords" }, { "type": "null" } ], "default": { "t": "time", "x": "longitude", "y": "latitude", "z": "depth", "s": "site" }, "description": "Names of the coordinates in the dataset" }, "crop_data": { "default": true, "description": "Update crop filters from Grid and Time objects if passed to get method", "title": "Crop Data", "type": "boolean" }, "buffer": { "default": 0.0, "description": "Space to buffer the grid bounding box if `filter_grid` is True", "title": "Buffer", "type": "number" }, "time_buffer": { "default": [ 0, 1 ], "description": "Number of source data timesteps to buffer the time range if `filter_time` is True", "items": { "type": "integer" }, "title": "Time Buffer", "type": "array" }, "data_type": { "const": "sflux_air", "default": "sflux_air", "description": "Model type discriminator", "title": "Data Type", "type": "string" }, "relative_weight": { "default": 1.0, "description": "relative weight of the source file if two files are provided", "title": "Relative Weight", "type": "number" }, "max_window_hours": { "default": 120.0, "description": "maximum number of hours (offset from start time in each file) in each file of set 1", "title": "Max Window Hours", "type": "number" }, "fail_if_missing": { "default": true, "description": "Fail if the source file is missing", "title": "Fail If Missing", "type": "boolean" }, "uwind_name": { "default": null, "description": "name of zonal wind variable in source", "title": "Uwind Name", "type": "string" }, "vwind_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "name of meridional wind variable in source", "title": "Vwind Name" }, "prmsl_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "name of mean sea level pressure variable in source", "title": "Prmsl Name" }, "stmp_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "name of surface air temperature variable in source", "title": "Stmp Name" }, "spfh_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "name of specific humidity variable in source", "title": "Spfh Name" } }, "required": [ "source" ], "title": "SfluxAir", "type": "object" }, "SfluxPrc": { "additionalProperties": false, "description": "This is a single variable source for and sflux input", "properties": { "model_type": { "const": "grid", "default": "grid", "description": "Model type discriminator", "title": "Model Type", "type": "string" }, "id": { "choices": [ "air", "rad", "prc" ], "default": null, "description": "id of the source", "title": "Id", "type": "string" }, "source": { "description": "Source reader, must return an xarray gridded dataset in the open method", "discriminator": { "mapping": { "csv": "#/$defs/SourceTimeseriesCSV", "datamesh": "#/$defs/SourceDatamesh", "file": "#/$defs/SourceFile", "intake": "#/$defs/SourceIntake", "wavespectra": "#/$defs/SourceWavespectra" }, "propertyName": "model_type" }, "oneOf": [ { "$ref": "#/$defs/SourceTimeseriesCSV" }, { "$ref": "#/$defs/SourceDatamesh" }, { "$ref": "#/$defs/SourceFile" }, { "$ref": "#/$defs/SourceIntake" }, { "$ref": "#/$defs/SourceWavespectra" } ], "title": "Source" }, "link": { "default": false, "description": "Whether to create a symbolic link instead of copying the file", "title": "Link", "type": "boolean" }, "filter": { "anyOf": [ { "$ref": "#/$defs/Filter" }, { "type": "null" } ], "description": "Optional filter specification to apply to the dataset" }, "variables": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": [], "description": "Subset of variables to extract from the dataset", "title": "Variables" }, "coords": { "anyOf": [ { "$ref": "#/$defs/DatasetCoords" }, { "type": "null" } ], "default": { "t": "time", "x": "longitude", "y": "latitude", "z": "depth", "s": "site" }, "description": "Names of the coordinates in the dataset" }, "crop_data": { "default": true, "description": "Update crop filters from Grid and Time objects if passed to get method", "title": "Crop Data", "type": "boolean" }, "buffer": { "default": 0.0, "description": "Space to buffer the grid bounding box if `filter_grid` is True", "title": "Buffer", "type": "number" }, "time_buffer": { "default": [ 0, 1 ], "description": "Number of source data timesteps to buffer the time range if `filter_time` is True", "items": { "type": "integer" }, "title": "Time Buffer", "type": "array" }, "data_type": { "const": "sflux_prc", "default": "sflux_rad", "description": "Model type discriminator", "title": "Data Type", "type": "string" }, "relative_weight": { "default": 1.0, "description": "relative weight of the source file if two files are provided", "title": "Relative Weight", "type": "number" }, "max_window_hours": { "default": 120.0, "description": "maximum number of hours (offset from start time in each file) in each file of set 1", "title": "Max Window Hours", "type": "number" }, "fail_if_missing": { "default": true, "description": "Fail if the source file is missing", "title": "Fail If Missing", "type": "boolean" }, "prate_name": { "default": null, "description": "name of precipitation rate variable in source", "title": "Prate Name", "type": "string" } }, "required": [ "source" ], "title": "SfluxPrc", "type": "object" }, "SfluxRad": { "additionalProperties": false, "description": "This is a single variable source for and sflux input", "properties": { "model_type": { "const": "grid", "default": "grid", "description": "Model type discriminator", "title": "Model Type", "type": "string" }, "id": { "choices": [ "air", "rad", "prc" ], "default": null, "description": "id of the source", "title": "Id", "type": "string" }, "source": { "description": "Source reader, must return an xarray gridded dataset in the open method", "discriminator": { "mapping": { "csv": "#/$defs/SourceTimeseriesCSV", "datamesh": "#/$defs/SourceDatamesh", "file": "#/$defs/SourceFile", "intake": "#/$defs/SourceIntake", "wavespectra": "#/$defs/SourceWavespectra" }, "propertyName": "model_type" }, "oneOf": [ { "$ref": "#/$defs/SourceTimeseriesCSV" }, { "$ref": "#/$defs/SourceDatamesh" }, { "$ref": "#/$defs/SourceFile" }, { "$ref": "#/$defs/SourceIntake" }, { "$ref": "#/$defs/SourceWavespectra" } ], "title": "Source" }, "link": { "default": false, "description": "Whether to create a symbolic link instead of copying the file", "title": "Link", "type": "boolean" }, "filter": { "anyOf": [ { "$ref": "#/$defs/Filter" }, { "type": "null" } ], "description": "Optional filter specification to apply to the dataset" }, "variables": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": [], "description": "Subset of variables to extract from the dataset", "title": "Variables" }, "coords": { "anyOf": [ { "$ref": "#/$defs/DatasetCoords" }, { "type": "null" } ], "default": { "t": "time", "x": "longitude", "y": "latitude", "z": "depth", "s": "site" }, "description": "Names of the coordinates in the dataset" }, "crop_data": { "default": true, "description": "Update crop filters from Grid and Time objects if passed to get method", "title": "Crop Data", "type": "boolean" }, "buffer": { "default": 0.0, "description": "Space to buffer the grid bounding box if `filter_grid` is True", "title": "Buffer", "type": "number" }, "time_buffer": { "default": [ 0, 1 ], "description": "Number of source data timesteps to buffer the time range if `filter_time` is True", "items": { "type": "integer" }, "title": "Time Buffer", "type": "array" }, "data_type": { "const": "sflux_rad", "default": "sflux_rad", "description": "Model type discriminator", "title": "Data Type", "type": "string" }, "relative_weight": { "default": 1.0, "description": "relative weight of the source file if two files are provided", "title": "Relative Weight", "type": "number" }, "max_window_hours": { "default": 120.0, "description": "maximum number of hours (offset from start time in each file) in each file of set 1", "title": "Max Window Hours", "type": "number" }, "fail_if_missing": { "default": true, "description": "Fail if the source file is missing", "title": "Fail If Missing", "type": "boolean" }, "dlwrf_name": { "default": null, "description": "name of downward long wave radiation variable in source", "title": "Dlwrf Name", "type": "string" }, "dswrf_name": { "default": null, "description": "name of downward short wave radiation variable in source", "title": "Dswrf Name", "type": "string" } }, "required": [ "source" ], "title": "SfluxRad", "type": "object" }, "SourceDatamesh": { "additionalProperties": false, "description": "Source dataset from Datamesh.\n\nDatamesh documentation: https://docs.oceanum.io/datamesh/index.html", "properties": { "model_type": { "const": "datamesh", "default": "datamesh", "description": "Model type discriminator", "title": "Model Type", "type": "string" }, "datasource": { "description": "The id of the datasource on Datamesh", "title": "Datasource", "type": "string" }, "token": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Datamesh API token, taken from the environment if not provided", "title": "Token" }, "kwargs": { "additionalProperties": true, "default": {}, "description": "Keyword arguments to pass to `oceanum.datamesh.Connector`", "title": "Kwargs", "type": "object" } }, "required": [ "datasource", "token" ], "title": "SourceDatamesh", "type": "object" }, "SourceFile": { "additionalProperties": false, "description": "Source dataset from file to open with xarray.open_dataset.", "properties": { "model_type": { "const": "file", "default": "file", "description": "Model type discriminator", "title": "Model Type", "type": "string" }, "uri": { "anyOf": [ { "type": "string" }, { "format": "path", "type": "string" } ], "description": "Path to the dataset", "title": "Uri" }, "kwargs": { "additionalProperties": true, "default": {}, "description": "Keyword arguments to pass to xarray.open_dataset", "title": "Kwargs", "type": "object" } }, "required": [ "uri" ], "title": "SourceFile", "type": "object" }, "SourceIntake": { "additionalProperties": false, "description": "Source dataset from intake catalog.\n\nnote\n----\nThe intake catalog can be prescribed either by the URI of an existing catalog file\nor by a YAML string defining the catalog. The YAML string can be obtained from\ncalling the `yaml()` method on an intake dataset instance.", "properties": { "model_type": { "const": "intake", "default": "intake", "description": "Model type discriminator", "title": "Model Type", "type": "string" }, "dataset_id": { "description": "The id of the dataset to read in the catalog", "title": "Dataset Id", "type": "string" }, "catalog_uri": { "anyOf": [ { "type": "string" }, { "format": "path", "type": "string" }, { "type": "null" } ], "default": null, "description": "The URI of the catalog to read from", "title": "Catalog Uri" }, "catalog_yaml": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The YAML string of the catalog to read from", "title": "Catalog Yaml" }, "kwargs": { "additionalProperties": true, "default": {}, "description": "Keyword arguments to define intake dataset parameters", "title": "Kwargs", "type": "object" } }, "required": [ "dataset_id" ], "title": "SourceIntake", "type": "object" }, "SourceTimeseriesCSV": { "additionalProperties": false, "description": "Timeseries source class from CSV file.\n\nThis class should return a timeseries from a CSV file. The dataset variables are\ndefined from the column headers, therefore the appropriate read_csv kwargs must be\npassed to allow defining the columns. The time index is defined from column name\nidentified by the tcol field.", "properties": { "model_type": { "const": "csv", "default": "csv", "description": "Model type discriminator", "title": "Model Type", "type": "string" }, "filename": { "anyOf": [ { "type": "string" }, { "format": "path", "type": "string" } ], "description": "Path to the csv file", "title": "Filename" }, "tcol": { "default": "time", "description": "Name of the column containing the time data", "title": "Tcol", "type": "string" }, "read_csv_kwargs": { "additionalProperties": true, "default": {}, "description": "Keyword arguments to pass to pandas.read_csv", "title": "Read Csv Kwargs", "type": "object" } }, "required": [ "filename" ], "title": "SourceTimeseriesCSV", "type": "object" }, "SourceWavespectra": { "additionalProperties": false, "description": "Wavespectra dataset from wavespectra reader.", "properties": { "model_type": { "const": "wavespectra", "default": "wavespectra", "description": "Model type discriminator", "title": "Model Type", "type": "string" }, "uri": { "anyOf": [ { "type": "string" }, { "format": "path", "type": "string" } ], "description": "Path to the dataset", "title": "Uri" }, "reader": { "description": "Name of the wavespectra reader to use, e.g., read_swan", "title": "Reader", "type": "string" }, "kwargs": { "additionalProperties": true, "default": {}, "description": "Keyword arguments to pass to the wavespectra reader", "title": "Kwargs", "type": "object" } }, "required": [ "uri", "reader" ], "title": "SourceWavespectra", "type": "object" }, "TidalDataset": { "additionalProperties": false, "description": "This class is used to define the tidal dataset", "properties": { "data_type": { "const": "tidal_dataset", "default": "tidal_dataset", "description": "Model type discriminator", "title": "Data Type", "type": "string" }, "elevations": { "description": "Path to elevations file", "title": "Elevations" }, "velocities": { "description": "Path to currents file", "title": "Velocities" } }, "required": [ "elevations", "velocities" ], "title": "TidalDataset", "type": "object" }, "Vgrid2D": { "additionalProperties": false, "properties": { "model_type": { "const": "vgrid2D_generator", "default": "vgrid2D_generator", "description": "Model descriminator", "title": "Model Type", "type": "string" } }, "title": "Vgrid2D", "type": "object" }, "Vgrid3D_LSC2": { "additionalProperties": false, "properties": { "model_type": { "const": "vgrid3D_lsc2", "default": "vgrid3D_lsc2", "description": "Model descriminator", "title": "Model Type", "type": "string" }, "hgrid": { "anyOf": [ { "$ref": "#/$defs/DataBlob" }, { "format": "path", "type": "string" } ], "description": "Path to hgrid.gr3 file", "title": "Hgrid" }, "hsm": { "description": "Depth for each master grid", "items": { "type": "number" }, "title": "Hsm", "type": "array" }, "nv": { "description": "Total number of vertical levels", "items": { "type": "integer" }, "title": "Nv", "type": "array" }, "h_c": { "description": "Transition depth between sigma and z-coordinates", "title": "H C", "type": "number" }, "theta_b": { "description": "Vertical resolution near the surface", "title": "Theta B", "type": "number" }, "theta_f": { "description": "Vertical resolution near the seabed", "title": "Theta F", "type": "number" }, "crs": { "default": "epsg:4326", "description": "Coordinate reference system", "title": "Crs", "type": "string" } }, "required": [ "hgrid", "hsm", "nv", "h_c", "theta_b", "theta_f" ], "title": "Vgrid3D_LSC2", "type": "object" }, "Vgrid3D_SZ": { "additionalProperties": false, "properties": { "model_type": { "const": "vgrid3D_sz", "default": "vgrid3D_sz", "description": "Model descriminator", "title": "Model Type", "type": "string" }, "hgrid": { "anyOf": [ { "$ref": "#/$defs/DataBlob" }, { "format": "path", "type": "string" } ], "description": "Path to hgrid.gr3 file", "title": "Hgrid" }, "h_s": { "description": "Depth for each master grid", "title": "H S", "type": "number" }, "ztot": { "description": "Total number of vertical levels", "items": { "type": "integer" }, "title": "Ztot", "type": "array" }, "h_c": { "description": "Transition depth between sigma and z-coordinates", "title": "H C", "type": "number" }, "theta_b": { "description": "Vertical resolution near the surface", "title": "Theta B", "type": "number" }, "theta_f": { "description": "Vertical resolution near the seabed", "title": "Theta F", "type": "number" }, "sigma": { "description": "Sigma levels", "items": { "type": "number" }, "title": "Sigma", "type": "array" } }, "required": [ "hgrid", "h_s", "ztot", "h_c", "theta_b", "theta_f", "sigma" ], "title": "Vgrid3D_SZ", "type": "object" }, "VgridGenerator": { "additionalProperties": false, "description": "Generate vgrid.in.\nThis is all hardcoded for now, may look at making this more flexible in the future.", "properties": { "model_type": { "const": "vgrid_generator", "default": "vgrid_generator", "description": "Model descriminator", "title": "Model Type", "type": "string" }, "vgrid": { "anyOf": [ { "$ref": "#/$defs/Vgrid2D" }, { "$ref": "#/$defs/Vgrid3D_LSC2" }, { "$ref": "#/$defs/Vgrid3D_SZ" } ], "description": "Type of vgrid to generate. 2d will create the minimum required for a 2d model. LSC2 will create a full vgrid for a 3d model using pyschsim's LSC2 class", "title": "Vgrid" } }, "title": "VgridGenerator", "type": "object" }, "WWMBNDGR3Generator": { "additionalProperties": false, "properties": { "model_type": { "const": "wwmbnd_generator", "default": "wwmbnd_generator", "description": "Model discriminator", "title": "Model Type", "type": "string" }, "hgrid": { "anyOf": [ { "$ref": "#/$defs/DataBlob" }, { "format": "path", "type": "string" } ], "description": "Path to hgrid.gr3 file", "title": "Hgrid" }, "bcflags": { "default": null, "description": "List of boundary condition flags. This replicates the functionality of the gen_wwmbnd.in file. Must be the same length as the number of open boundaries in the hgrid.gr3 file. If not specified, it is assumed that all open hgrid files are open to waves", "items": { "type": "integer" }, "title": "Bcflags", "type": "array" } }, "required": [ "hgrid" ], "title": "WWMBNDGR3Generator", "type": "object" } }, "additionalProperties": true, "required": [ "grid", "data" ] }
- Fields:
- Validators:
validate_bottom_friction»all fields
- field CGPP: str = 'F'#
peak group speed
- Validated by:
- field CPP: str = 'F'#
peak phase velocity
- Validated by:
- field DM: str = 'T'#
mean wave direction
- Validated by:
- field DPEAK: str = 'T'#
peak direction
- Validated by:
- field DSPR: str = 'T'#
directional spreading
- Validated by:
- field HS: str = 'T'#
significant wave height
- Validated by:
- field KPP: str = 'F'#
peak wave number
- Validated by:
- field LPP: str = 'F'#
peak wave length
- Validated by:
- field ORBITAL: str = 'F'#
bottom orbital velocity
- Validated by:
- field PEAKD: str = 'T'#
peak direction
- Validated by:
- field PEAKDSPR: str = 'T'#
peak directional spreading
- Validated by:
- field TM01: str = 'T'#
mean period
- Validated by:
- field TM02: str = 'F'#
zero-crossing mean period
- Validated by:
- field TPP: str = 'T'#
peak period
- Validated by:
- field TPPD: str = 'T'#
direaction of the peak … check source code
- Validated by:
- field UBOT: str = 'F'#
bottom exc. velocity
- Validated by:
- field WNPP: str = 'F'#
peak wave number
- Validated by:
- field ac: str = 'T'#
TODO
- Validated by:
- field brcrYN: str = ''#
Wave breaking parameterization (T/F)
- Validated by:
- field currYN: str = '!'#
Current data (T/F)
- Validated by:
- field data: SCHISMData [Required]#
Model inputs
- Validated by:
- field definetc: int = -1#
Definition of output time step (1-3)
- Validated by:
- field deltc: int = 360#
TODO
- Validated by:
- field deltc_out: int = 3600#
Output time step (s)
- Validated by:
- field dramp: float = 1.0#
TODO
- Validated by:
- field drampwafo: float = 1.0#
TODO
- Validated by:
- field drampwind: float = 1.0#
TODO
- Validated by:
- field dzb_decayYN: str = '!'#
TODO
- Validated by:
- field extrap: str = 'T'#
Extrapolation of wave boundary data (T/F)
- Validated by:
- field extrapYN: str = '!'#
Extrapolation of wave boundary data (T/F)
- Validated by:
- field filewind: str = 'wind.dat'#
Name of the wind data file
- Validated by:
- field fricc: float = 0.11#
Bottom friction factor
- Validated by:
- field grid: SCHISMGrid [Required]#
The model grid
- Validated by:
- field h1_bcc: float = 50.0#
Baroclinicity calculation in off/nearshore with iunder_deep=ibc=0. The ‘below-bottom’ gradient is zeroed out if h>=h2_bcc (i.e. like Z) or uses const extrap (i.e. like terrain-following) if h<=h1_bcc(<h2_bcc) (and linear transition in between based on local depth)
- Validated by:
- field h2_bcc: float = 100.0#
Baroclinicity calculation in off/nearshore with iunder_deep=ibc=0. The ‘below-bottom’ gradient is zeroed out if h>=h2_bcc (i.e. like Z) or uses const extrap (i.e. like terrain-following) if h<=h1_bcc(<h2_bcc) (and linear transition in between based on local depth)
- Validated by:
- field h_bcc1: float = 100.0#
Cut-off depth for cubic spline interpolation near bottom when computing horizontal gradients
- Validated by:
- field ibreak: int = 1#
Wave breaking parameterization (1-3)
- Validated by:
- field ibtrack_openbndYN: str = '!'#
TODO
- Validated by:
- field ic_elev: int = 0#
elevation initial condition flag for cold start only
- Validated by:
- field icou_elfe_wwm: int = 1#
If WWM is used, set coupling/decoupling flag. Not used if USE_WWM is distabled in Makefile. 0: decoupled so 2 models will run independently; 1: full coupled (elevation, vel, and wind are all passed to WWM); 2: elevation and currents in wwm, no wave force in SCHISM; 3: no elevation and no currents in wwm, wave force in SCHISM; 4: elevation but no currents in wwm, wave force in SCHISM; 5: elevation but no currents in wwm, no wave force in SCHISM; 6: no elevation but currents in wwm, wave force in SCHISM; 7: no elevation but currents in wwm, no wave force in SCHISM; Note that all these parameters must be present in this file (even though not used).
- Validated by:
- field ihfskip: float = 720#
stack spool; every ihfskip steps will be put into 1_*, 2_*, etc… use 22320.0 for 31 days; 5040 for 7 days; 21600 for 30 days; 20880 for 29 days
- Validated by:
- field ihot: int = 0#
hotstart 0: off; 1: on - whether to expect hotstarts - Default - 0-
- Validated by:
- field inv_atm_bnd: int = 1#
TODO
- Validated by:
- field iout_sta: int = 0#
Station output option
- Validated by:
- field iouts: str = 15#
- Validated by:
- field iwbl: int = 0#
wave boundary layer formulation (used only if USE_WMM and icou_elfe_wwm/=0 and nchi=1. If icou_elfe_wwm=0, set iwbl=0): 1-modified Grant-Madsen formulation; 2-Soulsby (1997)
- Validated by:
- field iwind_form: int = 1#
Needed if nws/=0 !usually use -1, trialling -2 to see if makes a difference
- Validated by:
- field iwindoffYN: str = '!'#
TODO
- Validated by:
- field limfak: float = 0.1#
Wave energy limit factor
- Validated by:
- field lindsprdeg: str = 'F'#
Linear interpolation of directional spread (T/F)
- Validated by:
- field lsourceswam: str = 'F'#
Source term for SWAN (T/F)
- Validated by:
- field lsp2d: str = 'T'#
TODO
- Validated by:
- field mdc2: int = 36#
same as mdc in .nml
- Validated by:
- field melim: int = 1#
Wave energy limit (1-3)
- Validated by:
- field mesbf: int = 2#
Output message level (0-2)
- Validated by:
- field mesin: int = 1#
Input message level (0-2)
- Validated by:
- field model_type: Literal['schismcsiro'] = 'schismcsiro'#
The model type for SCHISM.
- Validated by:
- field msc2: int = 36#
same as msc in .nml … for consitency check between SCHISM and WWM
- Validated by:
- field nadv: int = 1#
TODO
- Validated by:
- field nchi: int = -1#
bottom friction
- Validated by:
- field nouts: str = "'AWAC_in','AWAC_mid','AWAC_off','SPOT_1002','SPOT_1011','SPOT_1018','SPOT_1026'"#
TODO
- Validated by:
- field nstep_wwm: int = 3#
call WWM every this many time steps. If /=1, consider using quasi-steady mode in WWM
- Validated by:
- field outstyle: str = 'NC'#
Output style (NC/WW3)
- Validated by:
- field param_iof_hydro1: int = 1#
output 0: off; 1: on - elev. [m] {elev} 2D - Default 1
- Validated by:
- field param_iof_hydro10: int = 0#
output 0: off; 1: on - total flux=-flsu-fllu-(radu-radd) [W/m/m] {total_heat_flux} 2D - Default 0
- Validated by:
- field param_iof_hydro11: int = 0#
output 0: off; 1: on - evaporation rate [kg/m/m/s] {evaporation} 2D - Default 0
- Validated by:
- field param_iof_hydro12: int = 0#
output 0: off; 1: on - precipitation rate [kg/m/m/s] {precipitation} 2D - Default 0
- Validated by:
- field param_iof_hydro13: int = 0#
output 0: off; 1: on - Bottom stress vector [kg/m/s^2(Pa)] {bottom_stress} 2D vector - Default 0
- Validated by:
- field param_iof_hydro14: int = 0#
output 0: off; 1: on - wind velocity vector [m/s] {wind_speed} 2D vector - Default 0
- Validated by:
- field param_iof_hydro15: int = 0#
output 0: off; 1: on - wind stress vector [m^2/s/s] {wind_stress} 2D vector - Default 0
- Validated by:
- field param_iof_hydro16: int = 1#
output 0: off; 1: on - depth-averaged vel vector [m/s] {dahv} 2D vector - Default 1
- Validated by:
- field param_iof_hydro17: int = 0#
output 0: off; 1: on - vertical velocity [m/s] {vertical_velocity} 3D - Default 0
- Validated by:
- field param_iof_hydro18: int = 0#
output 0: off; 1: on - water temperature [C] {temp} 3D - Default 0
- Validated by:
- field param_iof_hydro19: int = 0#
output 0: off; 1: on - water salinity [PSU] {salt} 3D - Default 0
- Validated by:
- field param_iof_hydro2: int = 0#
output 0: off; 1: on - air pressure [Pa] {air_pressure} 2D - Default 0
- Validated by:
- field param_iof_hydro20: int = 0#
output 0: off; 1: on - water density [kg/m^3] {water_density} 3D - Default 0
- Validated by:
- field param_iof_hydro21: int = 0#
output 0: off; 1: on - eddy diffusivity [m^2/s] {diffusivity} 3D - Default 0
- Validated by:
- field param_iof_hydro22: int = 0#
output 0: off; 1: on - eddy viscosity [m^2/s] {viscosity} 3D - Default 0
- Validated by:
- field param_iof_hydro23: int = 0#
output 0: off; 1: on - turbulent kinetic energy {TKE} 3D - Default 0
- Validated by:
- field param_iof_hydro24: int = 0#
output 0: off; 1: on - turbulent mixing length [m] {mixing_length} 3D - Default 0
- Validated by:
- field param_iof_hydro25: int = 0#
output 0: off; 1: on - horizontal vel vector [m/s] {hvel} 3D vector - Default 0
- Validated by:
- field param_iof_hydro26: int = 0#
output 0: off; 1: on - horizontal vel vector defined @side [m/s] {hvel_side} 3D vector - Default 0
- Validated by:
- field param_iof_hydro27: int = 0#
output 0: off; 1: on - vertical vel. @elem [m/s] {wvel_elem} 3D vector - Default 0
- Validated by:
- field param_iof_hydro28: int = 0#
output 0: off; 1: on - T @prism centers [C] {temp_elem} 3D - Default 0
- Validated by:
- field param_iof_hydro29: int = 0#
output 0: off; 1: on - S @prism centers [PSU] {salt_elem} 3D - Default 0
- Validated by:
- field param_iof_hydro3: int = 0#
output 0: off; 1: on - air temperature [C] {air_temperature} 2D - Default 0
- Validated by:
- field param_iof_hydro30: int = 0#
output 0: off; 1: on - Barotropic pressure gradient force vector (m.s-2) @side centers {pressure_gradient} 2D vector - Default 0
- Validated by:
- field param_iof_hydro4: int = 0#
output 0: off; 1: on - Specific humidity [-] {specific_humidity} 2D - Default 0
- Validated by:
- field param_iof_hydro5: int = 0#
output 0: off; 1: on - solar (shortwave) radiation [W/m/m] {solar_radiation} 2D - Default 0
- Validated by:
- field param_iof_hydro6: int = 0#
output 0: off; 1: on - sensible flux (positive upward) [W/m/m] {sensible_flux} 2D - Default 0
- Validated by:
- field param_iof_hydro7: int = 0#
output 0: off; 1: on - latent heat flux (positive upward) [W/m/m] {latent_heat} 2D - Default 0
- Validated by:
- field param_iof_hydro8: int = 0#
output 0: off; 1: on - upward longwave radiation (positive upward) [W/m/m] {upward_longwave} 2D - Default 0
- Validated by:
- field param_iof_hydro9: int = 0#
output 0: off; 1: on - downward longwave radiation (positive downward) [W/m/m] {downward_longwave} 2D - Default 0
- Validated by:
- field param_nhot: int = 0#
use 1 to write out hotstart: output *_hotstart every ‘hotout_write’ steps
- Validated by:
- field param_nhot_write: float = 22320.0#
if enabled when nhot and nhotwriteYN enabled then must be a multiple of ihfskip if nhot=1
- Validated by:
- field param_nhot_writeYN: str = '!'#
enables or disables (!) the nhot write field
- Validated by:
- field param_nspool_sta: int = 30#
needed if iout_sta/=0; mod(nhot_write,nspool_sta) must=0 defaults to 30
- Validated by:
- field project: str = 'WAXA'#
TODO
- Validated by:
- field rlatitude: float = -29#
if ncor=-1
- Validated by:
- field sav_cdYN: str = '!'#
Save current direction (T/F)
- Validated by:
- field sfea0: float = -29.0#
Reference latitude for beta-plane approximation when ncor=1 (not used if ics=2)
- Validated by:
- field slam0: float = 120.0#
Reference latitude for beta-plane approximation when ncor=1 (not used if ics=2)
- Validated by:
- field template: str | None = '/opt/hostedtoolcache/Python/3.10.17/x64/lib/python3.10/site-packages/rompy/templates/schismcsiro'#
The path to the model template
- Validated by:
- field thetai: float = 0.8#
Implicitness factor (0.5<thetai<=1).
- Validated by:
- field time_step: float = 120.0#
TODO
- Validated by:
- field utc_start: int = 0#
TODO
- Validated by:
- field walvYN: str = '!'#
Wave-induced current data (T/F)
- Validated by:
- field wbdm: int = 90#
Wave boundary data mode (1-4)
- Validated by:
- field windYN: str = '!'#
Wind data (T/F)
- Validated by:
- field wwm1: int = 1#
sig. height (m) {sigWaveHeight} 2D
- Validated by:
- field wwm10: int = 0#
Continuous peak period based on higher order moments (sec) {continuousPeakPeriod} 2D
- Validated by:
- field wwm11: int = 0#
Peak phase vel. (m/s) {peakPhaseVel} 2D
- Validated by:
- field wwm12: int = 0#
Peak n-factor {peakNFactor} 2D
- Validated by:
- field wwm13: int = 0#
Peak group vel. (m/s) {peakGroupVel} 2D
- Validated by:
- field wwm14: int = 0#
Peak wave number {peakWaveNumber} 2D
- Validated by:
- field wwm15: int = 0#
Peak wave length {peakWaveLength} 2D
- Validated by:
- field wwm16: int = 1#
Peak (dominant) direction (degr) {dominantDirection} 2D
- Validated by:
- field wwm17: int = 1#
Peak directional spreading {peakSpreading} 2D
- Validated by:
- field wwm18: int = 1#
Discrete peak direction (radian?) {discretePeakDirectio} 2D
- Validated by:
- field wwm19: int = 0#
Orbital vel. (m/s) {orbitalVelocity} 2D
- Validated by:
- field wwm2: int = 1#
Mean average period (sec) - TM01 {meanWavePeriod} 2D
- Validated by:
- field wwm20: int = 0#
RMS Orbital vel. (m/s) {rmsOrbitalVelocity} 2D
- Validated by:
- field wwm21: int = 0#
Bottom excursion period (sec?) {bottomExcursionPerio} 2D
- Validated by:
- field wwm22: int = 0#
Bottom wave period (sec) {bottomWavePeriod} 2D
- Validated by:
- field wwm23: int = 0#
Uresell number based on peak period {UresellNumber} 2D
- Validated by:
- field wwm24: int = 0#
Friction velocity (m/s?) {frictionalVelocity} 2D
- Validated by:
- field wwm25: int = 0#
Charnock coefficient {CharnockCoeff} 2D
- Validated by:
- field wwm26: int = 0#
Rougness length {rougnessLength} 2D
- Validated by:
- field wwm27: int = 0#
Roller energy dissipation rate (W/m²) @nodes {Drol} 2D
- Validated by:
- field wwm28: int = 0#
Total wave energy dissipation rate by depth-induced breaking (W/m²) @nodes {wave_sbrtot} 2D
- Validated by:
- field wwm29: int = 0#
Total wave energy dissipation rate by bottom friction (W/m²) @nodes {wave_sbftot} 2D
- Validated by:
- field wwm3: int = 0#
Zero down crossing period for comparison with buoy (s) - TM02 {zeroDowncrossPeriod} 2D
- Validated by:
- field wwm30: int = 0#
Total wave energy dissipation rate by whitecapping (W/m²) @nodes {wave_sdstot} 2D
- Validated by:
- field wwm31: int = 0#
Total wave energy dissipation rate by vegetation (W/m²) @nodes {wave_svegtot} 2D
- Validated by:
- field wwm31YN: str = '!'#
Total wave energy dissipation rate by vegetation (W/m2) @nodes {wave_svegtot} 2D
- Validated by:
- field wwm32: int = 0#
Total wave energy input rate from atmospheric forcing (W/m²) @nodes {wave_sintot} 2D
- Validated by:
- field wwm32YN: str = '!'#
Total wave energy input rate from atmospheric forcing (W/m2) @nodes {wave_sintot} 2D
- Validated by:
- field wwm33: int = 0#
WWM_energy vector {waveEnergyDirX,Y} 2D vector
- Validated by:
- field wwm33YN: str = '!'#
WWM_energy vector {waveEnergyDirX,Y} 2D vector
- Validated by:
- field wwm34: int = 0#
Vertical Stokes velocity (m.s-1) @sides and whole levels {stokes_wvel} 3D
- Validated by:
- field wwm34YN: str = '!'#
Vertical Stokes velocity (m.s-1) @sides and whole levels {stokes_wvel} 3D
- Validated by:
- field wwm35: int = 0#
Wave force vector (m.s-2) computed by wwm @side centers and whole levels {waveForceX,Y} 3D vector
- Validated by:
- field wwm35YN: str = '!'#
Wave force vector (m.s-2) computed by wwm @side centers and whole levels {waveForceX,Y} 3D vector
- Validated by:
- field wwm36: int = 0#
Horizontal Stokes velocity (m.s-1) @nodes and whole levels {stokes_hvel} 3D vector
- Validated by:
- field wwm36YN: str = '!'#
Horizontal Stokes velocity (m.s-1) @nodes and whole levels {stokes_hvel} 3D vector
- Validated by:
- field wwm37: int = 0#
Roller contribution to horizontal Stokes velocity (m.s-1) @nodes and whole levels {roller_stokes_hvel} 3D vector
- Validated by:
- field wwm37YN: str = '!'#
Roller contribution to horizontal Stokes velocity (m.s-1) @nodes and whole levels {roller_stokes_hvel} 3D vector
- Validated by:
- field wwm4: int = 0#
Average period of wave runup/overtopping - TM10 {TM10} 2D
- Validated by:
- field wwm5: int = 0#
Mean wave number (1/m) {meanWaveNumber} 2D
- Validated by:
- field wwm6: int = 0#
Mean wave length (m) {meanWaveLength} 2D
- Validated by:
- field wwm7: int = 0#
Mean average energy transport direction (degr) - MWD in NDBC? {meanWaveDirection} 2D
- Validated by:
- field wwm8: int = 1#
Mean directional spreading (degr) {meanDirSpreading} 2D
- Validated by:
- field wwm9: int = 1#
Discrete peak period (sec) - Tp {peakPeriod} 2D
- Validated by:
- field wwminput_LHOTF: str = 'F'#
wwminput Write hotfile
- Validated by:
- field wwminput_LHOTR: str = 'F'#
Use hotstart file (see &HOTFILE section)
- Validated by:
- field wwminput_LINID: str = 'T'#
Initial condition; F for default; use T if using WW3 as i.c. etc
- Validated by:
- field wwminput_history_DELTC: int = 3600#
Time step for output; if smaller than simulation time step, the latter is used (output every step for better 1D 2D spectra analysis)
- Validated by:
- field wwminput_history_DEP: str = 'F'#
TODO
- Validated by:
- field wwminput_history_OUTSTYLE: str = 'NC'#
‘output option - use ‘NO’ for no output
- Validated by:
- field wwminput_history_STOKESBAROX: str = 'T'#
TODO
- Validated by:
- field wwminput_history_STOKESBAROY: str = 'T'#
TODO
- Validated by:
- field wwminput_history_STOKESSURFX: str = 'T'#
TODO
- Validated by:
- field wwminput_history_STOKESSURFY: str = 'T'#
TODO
- Validated by:
- field wwminput_history_TAUHF: str = 'T'#
TODO
- Validated by:
- field wwminput_history_TAUTOT: str = 'T'#
TODO
- Validated by:
- field wwminput_history_TAUW: str = 'F'#
TODO
- Validated by:
- field wwminput_hotfile_DELTC: int = 0#
hotfile time in UNITC (typically seconds) when hotfile should be written, defaults to 3600
- Validated by:
- field wwminput_station_DELTC: int = 3600#
Time step for output; if smaller than simulation time step, the latter is used (output every step for better 1D 2D spectra analysis)
- Validated by:
- field wwminput_station_DEP: str = 'T'#
TODO
- Validated by:
- field wwminput_station_OUTSTYLE: str = 'NO'#
‘NO’ no output ‘STE’ classic station output (default) ‘NC’ for netcdf output
- Validated by:
- field wwminput_station_STOKESBAROX: str = 'T'#
TODO
- Validated by:
- field wwminput_station_STOKESBAROY: str = 'T'#
TODO
- Validated by:
- field wwminput_station_STOKESSURFX: str = 'T'#
TODO
- Validated by:
- field wwminput_station_STOKESSURFY: str = 'T'#
TODO
- Validated by:
- field wwminput_station_TAUHF: str = 'T'#
TODO
- Validated by:
- field wwminput_station_TAUTOT: str = 'T'#
TODO
- Validated by:
- field wwminput_station_TAUW: str = 'T'#
TODO
- Validated by:
- field xouts: str = '115.6208687,115.5941886,115.58077,115.5942931,115.5830497,115.5807825,115.5960683'#
TODO
- Validated by:
- field youts: str = '-32.611605,-32.611605,-32.613682,-32.6253914,-32.6135870,-32.6294226,-32.6096741'#
TODO
- Validated by: