Merge branch 'development' into indep_vars

doc/source/contributing/quest-available-datasets.rst

@@ -0,0 +1,25 @@
+.. _quest_supported_label:
+
+QUEST Supported Datasets
+========================
+
+On this page, we outline the datasets that are supported by the QUEST module. Click on the links for each dataset to view information about the API and sensor/data platform used.
+
+
+List of Datasets
+----------------
+
+* `Argo <https://argo.ucsd.edu/data/>`_
+    * The Argo mission involves a series of floats that are designed to capture vertical ocean profiles of temperature, salinity, and pressure down to ~2000 m. Some floats are in support of BGC-Argo, which also includes data relevant for biogeochemical applications: oxygen, nitrate, chlorophyll, backscatter, and solar irradiance.
+    * (Link Kelsey's paper here)
+    * (Link to example workbook here)
+
+
+Adding a Dataset to QUEST
+-------------------------
+
+Want to add a new dataset to QUEST? No problem! QUEST includes a template script (``dataset.py``) that may be used to create your own querying module for a dataset of interest.
+
+Guidelines on how to construct your dataset module may be found here: (link to be added)
+
+Once you have developed a script with the template, you may request for the module to be added to QUEST via Github. Please see the How to Contribute page :ref:`dev_guide_label` for instructions on how to contribute to icepyx.

doc/source/example_notebooks/IS2_data_access.ipynb

@@ -79,7 +79,7 @@
     "\n",
     "There are three required inputs, depending on how you want to search for data. Two are required in all cases:\n",
     "- `short_name` = the data product of interest, known as its \"short name\".\n",
-    "See https://nsidc.org/data/icesat-2/data-sets for a list of the available data products.\n",
+    "See https://nsidc.org/data/icesat-2/products for a list of the available data products.\n",
     "- `spatial extent` = a region of interest to search within. This can be entered as a bounding box, polygon vertex coordinate pairs, or a polygon geospatial file (currently shp, kml, and gpkg are supported).\n",
     "    - bounding box: Given in decimal degrees for the lower left longitude, lower left latitude, upper right longitude, and upper right latitude\n",
     "    - polygon vertices: Given as longitude, latitude coordinate pairs of decimal degrees with the last entry a repeat of the first.\n",

doc/source/example_notebooks/IS2_data_read-in.ipynb

@@ -248,11 +248,13 @@
     "user_expressions": []
    },
    "source": [
-    "glob will not by default search all of the subdirectories for matching filepaths, but it has the ability to do so. To search recursively you need to 1) use `/**/` in the filepath to match any level of nested folders and 2) use the `recursive=True` argument. \n",
+    "glob will not by default search all of the subdirectories for matching filepaths, but it has the ability to do so.\n",
     "\n",
     "If you would like to search recursively, you can achieve this by either:\n",
-    "1. passing the `recursive` argument into `glob_kwargs`\n",
-    "2. using glob directly to create a list of filepaths"
+    "1. passing the `recursive` argument into `glob_kwargs` and including `\\**\\` in your filepath\n",
+    "2. using glob directly to create a list of filepaths\n",
+    "\n",
+    "Each of these two methods are shown below."
    ]
   },
   {

doc/source/index.rst

@@ -146,6 +146,7 @@ ICESat-2 datasets to enable scientific discovery.
    contributing/contribution_guidelines
    contributing/how_to_contribute
    contributing/icepyx_internals
+   contributing/quest-available-datasets
    contributing/attribution_link
    contributing/development_plan
    contributing/release_guide

icepyx/core/is2ref.py

@@ -267,8 +267,11 @@ def _default_varlists(product):
         return common_list
 
 
-# dev goal: check and test this function
 def gt2spot(gt, sc_orient):
+    warnings.warn(
+        "icepyx versions 0.8.0 and earlier used an incorrect spot number calculation."
+        "As a result, computations depending on spot number may be incorrect and should be redone."
+    )
 
     assert gt in [
         "gt1l",
@@ -282,39 +285,41 @@ def gt2spot(gt, sc_orient):
     gr_num = np.uint8(gt[2])
     gr_lr = gt[3]
 
+    # spacecraft oriented forward
     if sc_orient == 1:
         if gr_num == 1:
             if gr_lr == "l":
-                spot = 2
+                spot = 6
             elif gr_lr == "r":
-                spot = 1
+                spot = 5
         elif gr_num == 2:
             if gr_lr == "l":
                 spot = 4
             elif gr_lr == "r":
                 spot = 3
         elif gr_num == 3:
             if gr_lr == "l":
-                spot = 6
+                spot = 2
             elif gr_lr == "r":
-                spot = 5
+                spot = 1
 
+    # spacecraft oriented backward
     elif sc_orient == 0:
         if gr_num == 1:
             if gr_lr == "l":
-                spot = 5
+                spot = 1
             elif gr_lr == "r":
-                spot = 6
+                spot = 2
         elif gr_num == 2:
             if gr_lr == "l":
                 spot = 3
             elif gr_lr == "r":
                 spot = 4
         elif gr_num == 3:
             if gr_lr == "l":
-                spot = 1
+                spot = 5
             elif gr_lr == "r":
-                spot = 2
+                spot = 6
 
     if "spot" not in locals():
         raise ValueError("Could not compute the spot number.")