Merge pull request #63 from kthyng/improvements

more options for running different cases
axiom-data-science · Oct 13, 2023 · 0fc41ae · 0fc41ae
2 parents 287411a + 934e7a2
commit 0fc41ae
Show file tree

Hide file tree

Showing 11 changed files with 423 additions and 116 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -115,7 +115,7 @@
 
 # https://myst-nb.readthedocs.io/en/v0.9.0/use/execute.html
 # jupyter_execute_notebooks = "auto"  # deprecated
-nb_execution_mode = "force"
+nb_execution_mode = "cache"
 
 # -- nbsphinx specific options ----------------------------------------------
 # this allows notebooks to be run even if they produce errors.

diff --git a/docs/datasets.md b/docs/datasets.md
@@ -9,8 +9,12 @@ The NCEI netCDF feature types are useful because they describe what does and doe
 |                 | timeSeries     | profile        | timeSeriesProfile | trajectory (TODO)                     | trajectoryProfile     | grid (TODO)         |
 |---              |---             |---             |---                |---                                    | ---                   | ---                 |
 | Definition      | only t changes | only z changes | t and z change    | t, y, and x change                    | t, z, y, and x change | t changes, y/x grid |
-| Data types      | mooring, buoy  | CTD profile    | moored ADCP       | flow through, surface/drogued drifter | glider, transect of CTD profiles, towed ADCP   | satellite, HF Radar |
+| Data types      | mooring, buoy  | CTD profile    | moored ADCP       | flow through, 2D drifter | glider, transect of CTD profiles, towed ADCP, 3D drifter   | satellite, HF Radar |
 | maptypes        | point  | point  | point  | point(s), line, box | point(s), line, box | box |
+| X/Y are pairs (locstream) or grid | either locstream or grid | either locstream or grid | either locstream or grid | locstream | locstream | grid |
+| Which dimensions are independent from X/Y choice? |
+| T | Independent | Independent | Independent | match X/Y | match X/Y | Independent |
+| Z | Independent | Independent | Independent | Independent | match X/Y | Independent |
 
 
 

diff --git a/docs/whats_new.md b/docs/whats_new.md
@@ -1,5 +1,9 @@
 # What's New
 
+## v1.1.0 (October 13, 2023)
+* Continuing to improve functionality of flags to be able to control how model output is extracted
+* making code more robust to different use cases
+
 ## v1.0.0 (October 5, 2023)
 * more modularized code structure with much more testing
 * requires datasets to include catalog metadata of NCEI feature type and maptype (for plotting):

diff --git a/ocean_model_skill_assessor/featuretype.py b/ocean_model_skill_assessor/featuretype.py
@@ -3,17 +3,26 @@
 
 ftconfig = {}
 ftconfig["timeSeries"] = {
-    "make_time_series": False,
+    "locstreamT": False,
+    "locstreamZ": False,
 }
 ftconfig["profile"] = {
-    "make_time_series": False,
-}
-ftconfig["trajectoryProfile"] = {
-    "make_time_series": True,
+    "locstreamT": False,
+    "locstreamZ": False,
 }
 ftconfig["timeSeriesProfile"] = {
-    "make_time_series": True,
+    "locstreamT": False,
+    "locstreamZ": False,
+}
+ftconfig["trajectory"] = {
+    "locstreamT": True,
+    "locstreamZ": False,
+}
+ftconfig["trajectoryProfile"] = {
+    "locstreamT": True,
+    "locstreamZ": True,
 }
 ftconfig["grid"] = {
-    "make_time_series": False,
+    "locstreamT": False,
+    "locstreamZ": False,
 }