Merge branch 'development' into ci/split_publish_to_pypi

Author: JessicaS11

.all-contributorsrc

@@ -515,6 +515,15 @@
         "infra",
         "review"
       ]
+    },
+    {
+      "login": "emmanuel-ferdman",
+      "name": "Emmanuel Ferdman",
+      "avatar_url": "https://avatars.githubusercontent.com/u/35470921?v=4",
+      "profile": "https://github.com/emmanuel-ferdman",
+      "contributions": [
+        "code"
+      ]
     }
   ],
   "contributorsPerLine": 7,

.github/workflows/download_test.yml

@@ -29,6 +29,6 @@ jobs:
           pytest icepyx/tests/integration --verbose --cov app -m "downloads_data"
 
       - name: "Upload coverage report"
-        uses: "codecov/codecov-action@v5.4.0"
+        uses: "codecov/codecov-action@v5.4.3"
         with:
           token: "${{ secrets.CODECOV_TOKEN }}"

.github/workflows/integration_test.yml

@@ -63,6 +63,6 @@ jobs:
           pytest -s icepyx/tests/integration --verbose --cov app
 
       - name: "Upload coverage report"
-        uses: "codecov/codecov-action@v5.4.0"
+        uses: "codecov/codecov-action@v5.4.3"
         with:
           token: "${{ secrets.CODECOV_TOKEN }}"

.github/workflows/unit_test.yml

@@ -43,6 +43,6 @@ jobs:
           pytest icepyx/tests/unit --verbose --cov app
 
       - name: "Upload coverage report"
-        uses: "codecov/codecov-action@v5.4.0"
+        uses: "codecov/codecov-action@v5.4.3"
         with:
           token: "${{ secrets.CODECOV_TOKEN }}"

.pre-commit-config.yaml

@@ -26,7 +26,7 @@ repos:
           - tomli
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.11.8
+    rev: v0.11.12
     hooks:
       - id: ruff
         args: ["--fix", "--show-fixes"]

CONTRIBUTORS.rst

@@ -37,6 +37,7 @@
     "sphinx.ext.napoleon",
     "sphinx_autodoc_typehints",
     "sphinx.ext.autosectionlabel",
+    "sphinx.ext.intersphinx",
     "numpydoc",
     # "sphinx.ext.autosummary",
     "myst_nb",
@@ -107,6 +108,14 @@
 typehints_defaults = "comma"
 typehints_use_return = True
 
+# Options for intersphinx.
+intersphinx_mapping = {
+    "earthaccess": ("https://earthaccess.readthedocs.io/en/stable/", None),
+    "geopandas": ("https://geopandas.org/en/stable/", None),
+    "harmony": ("https://harmony-py.readthedocs.io/en/stable/", None),
+    "python": ("https://docs.python.org/3/", None),
+    "xarray": ("https://docs.xarray.dev/en/stable/", None),
+}
 
 # -- Options for HTML output -------------------------------------------------
 

doc/source/conf.py

@@ -26,7 +26,7 @@ def _fmt_temporal(start, end, key):
         Start date and time for the period of interest.
     end : date time object
         End date and time for the period of interest.
-    key : string
+    key : str
         Dictionary key, entered as a string, indicating which temporal format is needed.
         Must be one of ['temporal','time'] for data searching and subsetting, respectively.
 
@@ -108,7 +108,7 @@ def _fmt_var_subset_list(vdict):
 
     Parameters
     ----------
-    vdict : dictionary
+    vdict : dict
         Dictionary containing variable names as keys with values containing a list of
         paths to those variables (so each variable key may have multiple paths, e.g. for
         multiple beams)
@@ -163,7 +163,7 @@ def to_string(params):
 
     Parameters
     ----------
-    params : dictionary
+    params : dict
 
     Returns
     -------
@@ -223,14 +223,14 @@ class Parameters(Generic[T]):
 
     Parameters
     ----------
-    partype : string
+    partype : str
         Type of parameter list. Must be one of ['CMR','required','subset']
 
-    values : dictionary, default None
+    values : dict, default None
         Dictionary of already-formatted parameters, if there are any, to avoid
         re-creating them.
 
-    reqtype : string, default None
+    reqtype : str, default None
         For `partype=='required'`, indicates which parameters are required based
         on the type of query. Must be one of ['search','download']
     """

icepyx/core/APIformatting.py

@@ -47,15 +47,15 @@ def gran_IDs(grans, ids=False, cycles=False, tracks=False, dates=False, cloud=Fa
     ----------
     grans : list of dictionaries
         List of input granule json dictionaries. Must have key "producer_granule_id"
-    ids: boolean, default True
+    ids: bool, default True
         Return a list of the available granule IDs for the granule dictionary
-    cycles : boolean, default False
+    cycles : bool, default False
         Return a list of the available orbital cycles for the granule dictionary
-    tracks : boolean, default False
+    tracks : bool, default False
         Return a list of the available Reference Ground Tracks (RGTs) for the granule dictionary
-    dates : boolean, default False
+    dates : bool, default False
         Return a list of the available dates for the granule dictionary.
-    cloud : boolean, default False
+    cloud : bool, default False
         Return a a list of AWS s3 urls for the available granules in the granule dictionary.
     """
     assert len(grans) > 0, "Your data object has no granules associated with it"
@@ -272,21 +272,21 @@ def place_order(
         ----------
         CMRparams :
             Dictionary of properly formatted CMR search parameters.
-        subsetparams : dictionary
+        subsetparams : dict
             Dictionary of properly formatted subsetting parameters. An empty dictionary
             is passed as input here when subsetting is set to False in query methods.
-        verbose : boolean, default False
+        verbose : bool, default False
             Print out all feedback available from the order process.
             Progress information is automatically printed regardless of the value of verbose.
-        subset : boolean, default True
+        subset : bool, default True
             Apply subsetting to the data order from the NSIDC, returning only data that meets the
             subset parameters.
             Spatial and temporal subsetting based on the input parameters happens
             by default when subset=True, but additional subsetting options are available.
             Spatial subsetting returns all data that are within the area of interest
             (but not complete granules.
             This eliminates false-positive granules returned by the metadata-level search)
-        geom_filepath : string, default None
+        geom_filepath : str, default None
             String of the full filename and path when the spatial input is a file.
 
         Notes
@@ -312,12 +312,12 @@ def download(self, verbose, path, restart=False):
 
         Parameters
         ----------
-        verbose : boolean, default False
+        verbose : bool, default False
             Print out all feedback available from the order process.
             Progress information is automatically printed regardless of the value of verbose.
-        path : string
+        path : str
             String with complete path to desired download directory and location.
-        restart : boolean, default False
+        restart : bool, default False
             Restart your download if it has been interrupted.
             If the kernel has been restarted, but you successfully
             completed your order, you will need to re-initialize your query class object

icepyx/core/granules.py

@@ -31,7 +31,7 @@ class HarmonyApi(EarthdataAuthMixin):
     ----------
     harmony_client : harmony.Client
         The Harmony API client.
-    job_ids : list of str
+    job_ids : list[str]
         List of job IDs that have been placed with the Harmony API.
 
     """
@@ -85,13 +85,13 @@ def _place_order(
         ----------
         concept_id : str
             The concept ID of the dataset.
-        spatial : harmony.BBox, str, harmony.WKT, or None, optional
+        spatial : harmony.BBox, str, harmony.request.WKT, or None, optional
             The spatial extent for the order.
         temporal : HarmonyTemporal or None, optional
             The temporal range for the order.
         shape : str or None, optional
             A spatial shape file for filtering.
-        granule_name : list of str, optional
+        granule_name : list[str], optional
             Specific granule names to include in the order.
         skip_preview : bool, optional
             Whether to bypass preview mode if the order exceeds 300 granules.
@@ -234,13 +234,13 @@ def place_order(
         ----------
         concept_id : str
             The concept ID of the dataset.
-        spatial : harmony.BBox, str, harmony.WKT, or None, optional
+        spatial : harmony.BBox, str, harmony.request.WKT, or None, optional
             The spatial extent for the order.
         temporal : HarmonyTemporal or None, optional
             The temporal range for the order.
         shape : str or None, optional
             A spatial shape file for filtering.
-        granule_name : list of str, optional
+        granule_name : list[str], optional
             Specific granule names to include in the order.
         skip_preview : bool, optional
             Whether to bypass preview mode if the order exceeds 300 granules.