Merge branch 'development' into disable-ecs-tests

.github/workflows/integration_test.yml

@@ -6,33 +6,29 @@ on:
   push:
     branches:
       - "main"  # Releases
-      - "development"  # PR merges
+      - "development"  # Feature PR merges
   pull_request:
     branches:
-      - "main"  # Release pull requests
-  pull_request_review:
-    types:
-      - "submitted"
-    paths:
-      - ".github/**"
-      - "icepyx/**/*.py"
-      - "pyproject.toml"
-      - "requirements*.txt"
+      - "main"  # Release PRs
+  workflow_dispatch:
+    inputs:
+      ref:
+        description: "The ref to test"
+        type: "string"
 
 
 jobs:
   test:
     name: "Integration test"
-    # Job is conditional:
-    # - Do not run on PRs from forks
-    # - Do not run on `pull_request_review` events unless the PR is approved.
-    if: "${{ !github.event.pull_request.head.repo.fork && (github.event.action != 'pull_request_review' || github.event.review.state == 'approved') }}"
+    # Do not run on PRs from forks:
+    if: "${{ !github.event.pull_request.head.repo.fork }}"
     runs-on: "ubuntu-latest"
 
     steps:
       - uses: "actions/checkout@v4"
         with:
           fetch-depth: 0
+          ref: "${{ inputs.ref }}"
 
       - uses: "./.github/actions/install-icepyx"
         with:

.github/workflows/typecheck.yml

@@ -0,0 +1,29 @@
+name: Typecheck
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+      - development
+
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.10"
+
+      - name: Install package and test dependencies
+        run: |
+          python -m pip install .[complete]
+          python -m pip install -r requirements-dev.txt
+
+      - uses: jakebailey/pyright-action@v2

doc/source/conf.py

@@ -32,13 +32,17 @@
 # ones.
 extensions = [
     "sphinx.ext.autodoc",
+    # IMPORTANT: napoleon must be loaded before sphinx_autodoc_typehints
+    # https://github.com/tox-dev/sphinx-autodoc-typehints/issues/15
+    "sphinx.ext.napoleon",
+    "sphinx_autodoc_typehints",
     "sphinx.ext.autosectionlabel",
     "numpydoc",
     # "sphinx.ext.autosummary",
     "myst_nb",
     "contributors",  # custom extension, from pandas
     "sphinxcontrib.bibtex",
-    "sphinx_panels",
+    "sphinx_design",
     # "sphinx.ext.imgconverter", # this extension should help the latex svg warning, but results in an error instead
 ]
 myst_enable_extensions = [
@@ -79,6 +83,31 @@
 nb_execution_mode = "off"
 suppress_warnings = ["myst.header"]  # suppress non-consecutive header warning
 
+
+# -- Options for Napoleon docstring parsing ----------------------------------
+napoleon_google_docstring = False
+napoleon_numpy_docstring = True
+napoleon_use_admonition_for_examples = True
+napoleon_use_admonition_for_notes = True
+
+
+# -- Options for autodoc -----------------------------------------------------
+
+# Show the typehints in the description of each object instead of the signature.
+autodoc_typehints = "description"
+
+
+# -- Options for autodoc typehints--------------------------------------------
+
+# Replace Union annotations with union operator "|"
+always_use_bars_union = True
+# always_document_param_types = True
+
+# Show the default value for a parameter after its type
+typehints_defaults = "comma"
+typehints_use_return = True
+
+
 # -- Options for HTML output -------------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for

doc/source/index.rst

@@ -31,86 +31,109 @@ ICESat-2 datasets to enable scientific discovery.
 To further enhance data discovery, we have developed the QUEST module to facilitate querying of ICESat-2 data and complimentary Argo oceanographic data, with additional dataset support expected in the future.
 
 
-.. panels::
-    :card: + intro-card text-center
-    :column: col-lg-4 col-md-4 col-sm-6 col-xs-12 p-2
-    :img-top-cls: pl-2 pr-2 pt-2 pb-2
+.. grid:: 1 2 2 3
+    :gutter: 3
+    :class-container: sd-text-center
 
-    ---
-    :img-top: https://cdn-icons-png.flaticon.com/128/2498/2498074.png
+    .. grid-item-card::
+        :img-top: https://cdn-icons-png.flaticon.com/128/2498/2498074.png
+        :class-img-top: sd-p-2
+        :class-card: sd-shadow-md
 
-    **Getting Started**
-    ^^^^^^^^^^^^^^^^^^^
+        **Getting Started**
+        ^^^^^^^^^^^^^^^^^^^
 
-    New to ICESat-2 or icepyx?
-    Learn how to install icepyx and use it to jumpstart your project today.
-    Check out our gallery of examples, too!
+        New to ICESat-2 or icepyx?
+        Learn how to install icepyx and use it to jumpstart your project today.
+        Check out our gallery of examples, too!
 
-    .. link-button:: install_ref
-        :type: ref
-        :text: Installation Instructions
-        :classes: stretched-link btn-outline-primary btn-block
+        .. button-ref:: install_ref
+            :ref-type: ref
+            :color: primary
+            :outline:
+            :expand:
 
-    ---
-    :img-top: https://cdn-icons-png.flaticon.com/128/3730/3730041.png
+            Installation Instructions
 
-    **User Guide**
-    ^^^^^^^^^^^^^^
+    .. grid-item-card::
+        :img-top: https://cdn-icons-png.flaticon.com/128/3730/3730041.png
+        :class-img-top: sd-p-2
+        :class-card: sd-shadow-md
 
-    The user guide provides in-depth information on the tools and functionality
-    available for obtaining and interacting with ICESat-2 data products.
+        **User Guide**
+        ^^^^^^^^^^^^^^
 
-    .. link-button:: api_doc_ref
-        :type: ref
-        :text: Software Docs
-        :classes: stretched-link btn-outline-primary btn-block
+        The user guide provides in-depth information on the tools and functionality
+        available for obtaining and interacting with ICESat-2 data products.
 
-    ---
-    :img-top: https://cdn-icons-png.flaticon.com/512/4230/4230997.png
+        .. button-ref:: api_doc_ref
+            :ref-type: ref
+            :color: primary
+            :outline:
+            :expand:
 
-    **Development Guide**
-    ^^^^^^^^^^^^^^^^^^^^^
+            Software Docs
 
-    Have an idea or an ancillary dataset to contribute to icepyx? Go here for information on best practices
-    for developing and contributing to icepyx.
+    .. grid-item-card::
+        :img-top: https://cdn-icons-png.flaticon.com/512/4230/4230997.png
+        :class-img-top: sd-p-2
+        :class-card: sd-shadow-md
 
-    .. link-button:: dev_guide_label
-        :type: ref
-        :text: Development Guide
-        :classes: stretched-link btn-outline-primary btn-block
+        **Development Guide**
+        ^^^^^^^^^^^^^^^^^^^^^
 
-    ---
-    :img-top: https://cdn-icons-png.flaticon.com/128/1283/1283342.png
+        Have an idea or an ancillary dataset to contribute to icepyx? Go here for information on best practices
+        for developing and contributing to icepyx.
 
-    **Get in Touch**
-    ^^^^^^^^^^^^^^^^
+        .. button-ref:: dev_guide_label
+            :ref-type: ref
+            :color: primary
+            :outline:
+            :expand:
 
-    icepyx is more than just software!
-    We're a community of data producers, managers, and users
-    who collaborate openly and share code and skills
-    for every step along the entire data pipeline. Find resources for
-    your questions here!
+            Development Guide
 
-    .. link-button:: contact_ref_label
-        :type: ref
-        :text: Get Involved!
-        :classes: stretched-link btn-outline-primary btn-block
+    .. grid-item-card::
+        :img-top: https://cdn-icons-png.flaticon.com/128/1283/1283342.png
+        :class-img-top: sd-p-2
+        :class-card: sd-shadow-md
 
-    ---
-    :img-top: https://icesat-2.gsfc.nasa.gov/sites/default/files/MissionLogo_0.png
-    :img-top-cls: pl-2 pr-2 pt-4 pb-4
+        **Get in Touch**
+        ^^^^^^^^^^^^^^^^
 
-    **ICESat-2 Resources**
-    ^^^^^^^^^^^^^^^^^^^^^^
+        icepyx is more than just software!
+        We're a community of data producers, managers, and users
+        who collaborate openly and share code and skills
+        for every step along the entire data pipeline. Find resources for
+        your questions here!
 
-    Curious about other tools for working with ICESat-2 data?
-    Want to share your resource?
-    Check out the amazing work already in progress!
+        .. button-ref:: contact_ref_label
+            :ref-type: ref
+            :color: primary
+            :outline:
+            :expand:
 
-    .. link-button:: resource_ref_label
-        :type: ref
-        :text: ICESat-2 Resource Guide
-        :classes: stretched-link btn-outline-primary btn-block
+            Get Involved!
+
+    .. grid-item-card::
+        :img-top: https://icesat-2.gsfc.nasa.gov/sites/default/files/MissionLogo_0.png
+        :class-img-top: sd-p-2
+        :class-card: sd-shadow-md
+
+        **ICESat-2 Resources**
+        ^^^^^^^^^^^^^^^^^^^^^^
+
+        Curious about other tools for working with ICESat-2 data?
+        Want to share your resource?
+        Check out the amazing work already in progress!
+
+        .. button-ref:: resource_ref_label
+            :ref-type: ref
+            :color: primary
+            :outline:
+            :expand:
+
+            ICESat-2 Resource Guide
 
 
 .. toctree::

doc/source/user_guide/changelog/index.rst

@@ -7,9 +7,17 @@ This is the list of changes made to icepyx in between each release.
 Full details can be found in the `commit logs <https://github.com/icesat2py/icepyx/commits>`_.
 
 
-Latest Release (Version 1.2.0)
+Latest Release (Version 1.3.0)
 ------------------------------
 
+.. toctree::
+   :maxdepth: 2
+
+   v1.3.0
+
+Version 1.2.0
+-------------
+
 .. toctree::
    :maxdepth: 2
 

doc/source/user_guide/changelog/v1.3.0.rst

@@ -0,0 +1,81 @@
+What's new in 1.3.0 (13 September 2024)
+---------------------------------------
+
+These are the changes in icepyx 1.3.0 See :ref:`release` for a full changelog
+including other versions of icepyx.
+
+.. warning::
+    This is anticipated to be the last release in v1 of icepyx.
+
+    NSIDC (the NASA DAAC that hosts ICESat-2 data) is transitioning their
+    API endpoint from the on-premises EGI system to the cloud-based Harmony services.
+    icepyx is being updated to access these new services; the only change users
+    will experience concerns services that are no longer available (e.g. reformatting).
+
+    The developers plan to use this version change to implement additional breaking
+    changes concerning the Query module, transitioning it's functionality to use
+    the earthaccess library instead.
+
+    Find more details on all these changes, including their progress, on GitHub issues and discussions.
+
+
+Bug fixes
+~~~~~~~~~
+
+- Bugfix: catch multiple types of exceptions (#560)
+
+
+Deprecations
+~~~~~~~~~~~~
+
+- Drop support for Python 3.7 and 3.8 (#608)
+- Add v1.x deprecation warning (#603)
+
+
+Maintenance
+^^^^^^^^^^^
+
+- Avoid running tests that require creds on PRs (#563)
+
+    - enables PRs from forks to pass CI tests and be merged
+
+- Skip linting and formatting Jupyter Notebooks for now (#567)
+- Keep GitHub Actions up to date with GitHub's Dependabot (#555)
+- Bump the github-actions group with 3 updates (#568)
+- Add codespell spelling/typo linter and fix errors (#556)
+- Validate pyproject.toml (#557)
+- Enable currently-ignored linting rules E721, E722, F403 (#573)
+- Add ruff rules C4 to check comprehensions (#570)
+- Add ruff rules SIM to simplify Python code (#572)
+- More ruff & pre-commit rules (#546)
+- Fix minor typo (#589)
+- Extract constant URLs to own module (#591)
+- Clarify some comments / docstrings (#592)
+- Migrate unit and integration tests from TravisCI to GitHub Actions (#580)
+- Reinstate test_download_granules_without_subsetting (#581)
+
+    - Ensure that granules can be ordered from NSIDC and downloaded with the `subset=False` option.
+    - Also fix a possible race condition in case the NSIDC order status is completed right at the start (e.g. when order was cached/done already).
+
+- Bump sangonzal/repository-traffic-action from 0.1.5 to 1 in the github-actions group (#596)
+- [pre-commit.ci] pre-commit autoupdate (#597)
+- bump sangonzal/repository-traffic-action version to latest working one (fixes #596) (#601)
+- Replace integration test review trigger with manual trigger (#595)
+
+
+Documentation
+^^^^^^^^^^^^^
+
+- Update viz doc to clarify its current status (partial functionality - incompatible with OA API changes) (#540)
+- Add quickstart to README (#549)
+- docs: add cclauss as a contributor for maintenance and review (#583)
+- docs: add jrenrut as a contributor for bug, and code (#586)
+- docs: add mfisher87 as a contributor for bug, code, and 4 more (#585)
+- Tweak format and wording of contributor doc (#566)
+- [docs] traffic updates May-Aug 2024 (#606)
+
+
+Contributors
+~~~~~~~~~~~~
+
+.. contributors:: v1.2.0..v1.3.0|HEAD