Expose schism, ww3 drivers to CLI (#613)

ufs-community · Oct 21, 2024 · 8f317d6 · 8f317d6
1 parent c00a82d
commit 8f317d6
Show file tree

Hide file tree

Showing 60 changed files with 412 additions and 216 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -58,13 +58,15 @@
     "rocoto": ("https://christopherwharrop.github.io/rocoto/%s", "%s"),
     "rst": ("https://www.sphinx-doc.org/en/master/usage/restructuredtext/%s", "%s"),
     "rtd": ("https://readthedocs.org/projects/uwtools/%s", "%s"),
+    "schism": ("https://schism-dev.github.io/schism/master/%s", "%s"),
     "sfc-climo-gen": ("https://ufs-community.github.io/UFS_UTILS/sfc_climo_gen/%s", "%s"),
     "shell-redirection": ("https://www.gnu.org/software/bash/manual/html_node/Redirections.html%s", "%s"),
     "ufs": ("https://ufs.epic.noaa.gov/%s", "%s"),
     "ufs-utils": ("https://noaa-emcufs-utils.readthedocs.io/en/latest/ufs_utils.html#%s", "%s"),
     "ufs-weather-model": ("https://github.com/ufs-community/ufs-weather-model/%s", "%s"),
     "uwtools": ("https://github.com/ufs-community/uwtools/%s", "%s"),
     "weather-model-io": ("https://ufs-weather-model.readthedocs.io/en/latest/InputsOutputs.html#%s", "%s"),
+    "ww3": ("https://polar.ncep.noaa.gov/waves/wavewatch/%s", "%s"),
 }
 
 def setup(app):

diff --git a/docs/sections/user_guide/cli/drivers/cdeps/show-schema.cmd b/docs/sections/user_guide/cli/drivers/cdeps/show-schema.cmd
@@ -1,2 +1,2 @@
 uw cdeps --show-schema >schema
-head schema && echo ... && tail schema
+head -n20 schema
diff --git a/docs/sections/user_guide/cli/drivers/cdeps/show-schema.out b/docs/sections/user_guide/cli/drivers/cdeps/show-schema.out
@@ -8,14 +8,13 @@
           "additionalProperties": false,
           "properties": {
             "dtlimit": {
-...
-      "required": [
-        "rundir"
-      ]
-    }
-  },
-  "required": [
-    "cdeps"
-  ],
-  "type": "object"
-}
+              "type": "number"
+            },
+            "mapalgo": {
+              "type": "string"
+            },
+            "readmode": {
+              "enum": [
+                "single"
+              ]
+            },
diff --git a/docs/sections/user_guide/cli/drivers/chgres_cube/show-schema.cmd b/docs/sections/user_guide/cli/drivers/chgres_cube/show-schema.cmd
@@ -1,2 +1,2 @@
 uw chgres_cube --show-schema >schema
-head schema && echo ... && tail schema
+head -n20 schema
diff --git a/docs/sections/user_guide/cli/drivers/chgres_cube/show-schema.out b/docs/sections/user_guide/cli/drivers/chgres_cube/show-schema.out
@@ -8,14 +8,13 @@
           "properties": {
             "batchargs": {
               "additionalProperties": true,
-...
-        "rundir"
-      ],
-      "type": "object"
-    }
-  },
-  "required": [
-    "chgres_cube"
-  ],
-  "type": "object"
-}
+              "properties": {
+                "cores": {
+                  "type": "integer"
+                },
+                "debug": {
+                  "type": "boolean"
+                },
+                "exclusive": {
+                  "type": "boolean"
+                },
diff --git a/docs/sections/user_guide/cli/drivers/esg_grid/show-schema.cmd b/docs/sections/user_guide/cli/drivers/esg_grid/show-schema.cmd
@@ -1,2 +1,2 @@
 uw esg_grid --show-schema >schema
-head schema && echo ... && tail schema
+head -n20 schema
diff --git a/docs/sections/user_guide/cli/drivers/esg_grid/show-schema.out b/docs/sections/user_guide/cli/drivers/esg_grid/show-schema.out
@@ -8,14 +8,13 @@
       "properties": {
         "regional_grid_nml": {
           "additionalProperties": false,
-...
-        "rundir"
-      ],
-      "type": "object"
-    }
-  },
-  "required": [
-    "esg_grid"
-  ],
-  "type": "object"
-}
+          "properties": {
+            "delx": {
+              "type": "number"
+            },
+            "dely": {
+              "type": "number"
+            },
+            "lx": {
+              "type": "number"
+            },
diff --git a/docs/sections/user_guide/cli/drivers/filter_topo/show-schema.cmd b/docs/sections/user_guide/cli/drivers/filter_topo/show-schema.cmd
@@ -1,2 +1,2 @@
 uw filter_topo --show-schema >schema
-head schema && echo ... && tail schema
+head -n20 schema
diff --git a/docs/sections/user_guide/cli/drivers/filter_topo/show-schema.out b/docs/sections/user_guide/cli/drivers/filter_topo/show-schema.out
@@ -8,14 +8,13 @@
           "properties": {
             "filtered_orog": {
               "type": "string"
-...
-        "rundir"
-      ],
-      "type": "object"
-    }
-  },
-  "required": [
-    "filter_topo"
-  ],
-  "type": "object"
-}
+            },
+            "input_grid_file": {
+              "type": "string"
+            },
+            "input_raw_orog": {
+              "type": "string"
+            }
+          },
+          "required": [
+            "filtered_orog",
diff --git a/docs/sections/user_guide/cli/drivers/fv3/show-schema.cmd b/docs/sections/user_guide/cli/drivers/fv3/show-schema.cmd
@@ -1,2 +1,2 @@
 uw fv3 --show-schema >schema
-head schema && echo ... && tail schema
+head -n20 schema
diff --git a/docs/sections/user_guide/cli/drivers/fv3/show-schema.out b/docs/sections/user_guide/cli/drivers/fv3/show-schema.out
@@ -8,14 +8,13 @@
             "properties": {
               "domain": {
                 "const": "regional"
-...
-        "rundir"
+              }
+            }
+          },
+          "then": {
+            "required": [
+              "lateral_boundary_conditions"
+            ]
+          }
+        }
       ],
-      "type": "object"
-    }
-  },
-  "required": [
-    "fv3"
-  ],
-  "type": "object"
-}
diff --git a/docs/sections/user_guide/cli/drivers/global_equiv_resol/show-schema.cmd b/docs/sections/user_guide/cli/drivers/global_equiv_resol/show-schema.cmd
@@ -1,2 +1,2 @@
 uw global_equiv_resol --show-schema >schema
-head schema && echo ... && tail schema
+head -n20 schema
diff --git a/docs/sections/user_guide/cli/drivers/global_equiv_resol/show-schema.out b/docs/sections/user_guide/cli/drivers/global_equiv_resol/show-schema.out
@@ -8,14 +8,13 @@
           "properties": {
             "batchargs": {
               "additionalProperties": true,
-...
-        "rundir"
-      ],
-      "type": "object"
-    }
-  },
-  "required": [
-    "global_equiv_resol"
-  ],
-  "type": "object"
-}
+              "properties": {
+                "cores": {
+                  "type": "integer"
+                },
+                "debug": {
+                  "type": "boolean"
+                },
+                "exclusive": {
+                  "type": "boolean"
+                },
diff --git a/docs/sections/user_guide/cli/drivers/index.rst b/docs/sections/user_guide/cli/drivers/index.rst
@@ -20,7 +20,9 @@ Drivers
    mpas_init/index
    orog/index
    orog_gsl/index
+   schism/index
    sfc_climo_gen/index
    shave/index
    ungrib/index
    upp/index
+   ww3/index
diff --git a/docs/sections/user_guide/cli/drivers/ioda/show-schema.cmd b/docs/sections/user_guide/cli/drivers/ioda/show-schema.cmd
@@ -1,2 +1,2 @@
 uw ioda --show-schema >schema
-head schema && echo ... && tail schema
+head -n20 schema
diff --git a/docs/sections/user_guide/cli/drivers/ioda/show-schema.out b/docs/sections/user_guide/cli/drivers/ioda/show-schema.out
@@ -8,14 +8,13 @@
           "anyOf": [
             {
               "required": [
-...
-        "rundir"
-      ],
-      "type": "object"
-    }
-  },
-  "required": [
-    "ioda"
-  ],
-  "type": "object"
-}
+                "base_file"
+              ]
+            },
+            {
+              "required": [
+                "update_values"
+              ]
+            }
+          ],
+          "properties": {
diff --git a/docs/sections/user_guide/cli/drivers/jedi/show-schema.cmd b/docs/sections/user_guide/cli/drivers/jedi/show-schema.cmd
@@ -1,2 +1,2 @@
 uw jedi --show-schema >schema
-head schema && echo ... && tail schema
+head -n20 schema
diff --git a/docs/sections/user_guide/cli/drivers/jedi/show-schema.out b/docs/sections/user_guide/cli/drivers/jedi/show-schema.out
@@ -8,14 +8,13 @@
           "anyOf": [
             {
               "required": [
-...
-        "rundir"
-      ],
-      "type": "object"
-    }
-  },
-  "required": [
-    "jedi"
-  ],
-  "type": "object"
-}
+                "base_file"
+              ]
+            },
+            {
+              "required": [
+                "update_values"
+              ]
+            }
+          ],
+          "properties": {
diff --git a/docs/sections/user_guide/cli/drivers/make_hgrid/show-schema.cmd b/docs/sections/user_guide/cli/drivers/make_hgrid/show-schema.cmd
@@ -1,2 +1,2 @@
 uw make_hgrid --show-schema >schema
-head schema && echo ... && tail schema
+head -n20 schema
diff --git a/docs/sections/user_guide/cli/drivers/make_hgrid/show-schema.out b/docs/sections/user_guide/cli/drivers/make_hgrid/show-schema.out
@@ -8,14 +8,13 @@
           "allOf": [
             {
               "if": {
-...
-        "execution",
-        "rundir"
-      ]
-    }
-  },
-  "required": [
-    "make_hgrid"
-  ],
-  "type": "object"
-}
+                "properties": {
+                  "grid_type": {
+                    "const": "from_file"
+                  }
+                }
+              },
+              "then": {
+                "required": [
+                  "my_grid_file"
+                ]
diff --git a/docs/sections/user_guide/cli/drivers/make_solo_mosaic/show-schema.cmd b/docs/sections/user_guide/cli/drivers/make_solo_mosaic/show-schema.cmd
@@ -1,2 +1,2 @@
 uw make_solo_mosaic --show-schema >schema
-head schema && echo ... && tail schema
+head -n20 schema
diff --git a/docs/sections/user_guide/cli/drivers/make_solo_mosaic/show-schema.out b/docs/sections/user_guide/cli/drivers/make_solo_mosaic/show-schema.out
@@ -8,14 +8,13 @@
           "properties": {
             "dir": {
               "type": "string"
-...
-        "rundir"
-      ],
-      "type": "object"
-    }
-  },
-  "required": [
-    "make_solo_mosaic"
-  ],
-  "type": "object"
-}
+            },
+            "mosaic_name": {
+              "type": "string"
+            },
+            "num_tiles": {
+              "type": "integer"
+            },
+            "periodx": {
+              "type": "integer"
+            },
diff --git a/docs/sections/user_guide/cli/drivers/mpas/show-schema.cmd b/docs/sections/user_guide/cli/drivers/mpas/show-schema.cmd
@@ -1,2 +1,2 @@
 uw mpas --show-schema >schema
-head schema && echo ... && tail schema
+head -n20 schema
diff --git a/docs/sections/user_guide/cli/drivers/mpas/show-schema.out b/docs/sections/user_guide/cli/drivers/mpas/show-schema.out
@@ -8,14 +8,13 @@
           "properties": {
             "batchargs": {
               "additionalProperties": true,
-...
-        "streams"
-      ],
-      "type": "object"
-    }
-  },
-  "required": [
-    "mpas"
-  ],
-  "type": "object"
-}
+              "properties": {
+                "cores": {
+                  "type": "integer"
+                },
+                "debug": {
+                  "type": "boolean"
+                },
+                "exclusive": {
+                  "type": "boolean"
+                },
diff --git a/docs/sections/user_guide/cli/drivers/mpas_init/show-schema.cmd b/docs/sections/user_guide/cli/drivers/mpas_init/show-schema.cmd
@@ -1,2 +1,2 @@
 uw mpas_init --show-schema >schema
-head schema && echo ... && tail schema
+head -n20 schema
diff --git a/docs/sections/user_guide/cli/drivers/mpas_init/show-schema.out b/docs/sections/user_guide/cli/drivers/mpas_init/show-schema.out
@@ -8,14 +8,13 @@
           "properties": {
             "interval_hours": {
               "minimum": 1,
-...
-        "streams"
-      ],
-      "type": "object"
-    }
-  },
-  "required": [
-    "mpas_init"
-  ],
-  "type": "object"
-}
+              "type": "integer"
+            },
+            "length": {
+              "minimum": 1,
+              "type": "integer"
+            },
+            "offset": {
+              "minimum": 0,
+              "type": "integer"
+            },
diff --git a/docs/sections/user_guide/cli/drivers/orog/show-schema.cmd b/docs/sections/user_guide/cli/drivers/orog/show-schema.cmd
@@ -1,2 +1,2 @@
 uw orog --show-schema >schema
-head schema && echo ... && tail schema
+head -n20 schema