Merge pull request #64 from ASFHyP3/develop

Release v0.9.1

.github/workflows/changelog.yml

@@ -14,4 +14,4 @@ on:
 jobs:
   call-changelog-check-workflow:
     # Docs: https://github.com/ASFHyP3/actions
-    uses: ASFHyP3/actions/.github/workflows/reusable-changelog-check.yml@v0.11.2
+    uses: ASFHyP3/actions/.github/workflows/reusable-changelog-check.yml@v0.12.0

.github/workflows/labeled-pr.yml

@@ -13,4 +13,4 @@ on:
 jobs:
   call-labeled-pr-check-workflow:
     # Docs: https://github.com/ASFHyP3/actions
-    uses: ASFHyP3/actions/.github/workflows/reusable-labeled-pr-check.yml@v0.11.2
+    uses: ASFHyP3/actions/.github/workflows/reusable-labeled-pr-check.yml@v0.12.0

.github/workflows/release-checklist-comment.yml

@@ -10,7 +10,7 @@ on:
 jobs:
   call-release-workflow:
     # Docs: https://github.com/ASFHyP3/actions
-    uses: ASFHyP3/actions/.github/workflows/reusable-release-checklist-comment.yml@v0.11.2
+    uses: ASFHyP3/actions/.github/workflows/reusable-release-checklist-comment.yml@v0.12.0
     permissions:
       pull-requests: write
     secrets:

.github/workflows/release.yml

@@ -8,7 +8,7 @@ on:
 jobs:
   call-release-workflow:
     # Docs: https://github.com/ASFHyP3/actions
-    uses: ASFHyP3/actions/.github/workflows/reusable-release.yml@v0.11.2
+    uses: ASFHyP3/actions/.github/workflows/reusable-release.yml@v0.12.0
     with:
       release_prefix: HyP3 SRG
       release_branch: main

.github/workflows/static-analysis.yml

@@ -5,10 +5,8 @@ on: push
 jobs:
   call-secrets-analysis-workflow:
     # Docs: https://github.com/ASFHyP3/actions
-    uses: ASFHyP3/actions/.github/workflows/reusable-secrets-analysis.yml@v0.11.2
+    uses: ASFHyP3/actions/.github/workflows/reusable-secrets-analysis.yml@v0.12.0
 
-  call-flake8-workflow:
+  call-ruff-workflow:
     # Docs: https://github.com/ASFHyP3/actions
-    uses: ASFHyP3/actions/.github/workflows/[email protected]
-    with:
-      local_package_names: hyp3_srg
+    uses: ASFHyP3/actions/.github/workflows/[email protected]

.github/workflows/tag-version.yml

@@ -8,7 +8,7 @@ on:
 jobs:
   call-bump-version-workflow:
     # Docs: https://github.com/ASFHyP3/actions
-    uses: ASFHyP3/actions/.github/workflows/reusable-bump-version.yml@v0.11.2
+    uses: ASFHyP3/actions/.github/workflows/reusable-bump-version.yml@v0.12.0
     with:
       user: tools-bot
       email: [email protected]

.github/workflows/test-and-build.yml

@@ -13,15 +13,15 @@ on:
 jobs:
   call-pytest-workflow:
     # Docs: https://github.com/ASFHyP3/actions
-    uses: ASFHyP3/actions/.github/workflows/reusable-pytest.yml@v0.11.2
+    uses: ASFHyP3/actions/.github/workflows/reusable-pytest.yml@v0.12.0
     with:
       local_package_name: hyp3_srg
       python_versions: >-
         ["3.10", "3.11", "3.12", "3.13"]
 
   call-version-info-workflow:
     # Docs: https://github.com/ASFHyP3/actions
-    uses: ASFHyP3/actions/.github/workflows/reusable-version-info.yml@v0.11.2
+    uses: ASFHyP3/actions/.github/workflows/reusable-version-info.yml@v0.12.0
     with:
       python_version: "3.10"
 

CHANGELOG.md

@@ -6,6 +6,11 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [PEP 440](https://www.python.org/dev/peps/pep-0440/)
 and uses [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.9.1]
+
+### Changed
+* The [`static-analysis`](.github/workflows/static-analysis.yml) Github Actions workflow now uses `ruff` rather than `flake8` for linting.
+
 ## [0.9.0]
 
 ### Added

environment.yml

@@ -6,10 +6,7 @@ dependencies:
   - python>=3.10
   - pip
   # For packaging, and testing
-  - flake8
-  - flake8-import-order
-  - flake8-blind-except
-  - flake8-builtins
+  - ruff
   - setuptools
   - setuptools_scm
   - wheel

pyproject.toml

@@ -30,10 +30,7 @@ dynamic = ["version", "readme"]
 
 [project.optional-dependencies]
 develop = [
-    "flake8",
-    "flake8-import-order",
-    "flake8-blind-except",
-    "flake8-builtins",
+    "ruff",
     "pytest",
     "pytest-cov",
     "pytest-console-scripts",
@@ -62,3 +59,29 @@ readme = {file = ["README.md"], content-type = "text/markdown"}
 where = ["src"]
 
 [tool.setuptools_scm]
+
+[tool.ruff]
+line-length = 120
+src = ["src", "tests"]
+
+[tool.ruff.format]
+indent-style = "space"
+quote-style = "single"
+
+[tool.ruff.lint]
+extend-select = [
+    "I",   # isort: https://docs.astral.sh/ruff/rules/#isort-i
+
+    # TODO: uncomment the following extensions and address their warnings:
+    #"UP",  # pyupgrade: https://docs.astral.sh/ruff/rules/#pyupgrade-up
+    #"D",   # pydocstyle: https://docs.astral.sh/ruff/rules/#pydocstyle-d
+    #"ANN", # annotations: https://docs.astral.sh/ruff/rules/#flake8-annotations-ann
+    #"PTH", # use-pathlib-pth: https://docs.astral.sh/ruff/rules/#flake8-use-pathlib-pth
+]
+
+[tool.ruff.lint.pydocstyle]
+convention = "google"
+
+[tool.ruff.lint.isort]
+case-sensitive = true
+lines-after-imports = 2

src/hyp3_srg/__init__.py

@@ -2,6 +2,7 @@
 
 from importlib.metadata import version
 
+
 __version__ = version(__name__)
 
 __all__ = [

src/hyp3_srg/__main__.py

@@ -1,6 +1,5 @@
-"""
-HyP3 plugin for Stanford Radar Group (SRG) SAR Processor
-"""
+"""HyP3 plugin for Stanford Radar Group (SRG) SAR Processor"""
+
 import argparse
 import sys
 from importlib.metadata import entry_points

src/hyp3_srg/back_projection.py

@@ -1,13 +1,11 @@
-"""
-GSLC back-projection processing
-"""
+"""GSLC back-projection processing"""
 
 import argparse
 import logging
 import os
 import zipfile
+from collections.abc import Iterable
 from pathlib import Path
-from typing import Iterable, Optional
 
 from hyp3lib.aws import upload_file_to_s3
 from shapely import unary_union
@@ -93,7 +91,7 @@ def back_project(
     bucket: str = None,
     bucket_prefix: str = '',
     use_gslc_prefix: bool = False,
-    work_dir: Optional[Path] = None,
+    work_dir: Path | None = None,
     gpu: bool = False,
 ):
     """Back-project a set of Sentinel-1 level-0 granules.
@@ -162,17 +160,27 @@ def main():
         help=(
             'Upload GSLC granules to a subprefix located within the bucket and prefix given by the'
             ' --bucket and --bucket-prefix options'
-        )
+        ),
+    )
+    parser.add_argument(
+        '--gpu',
+        default=False,
+        action='store_true',
+        help='Use the GPU-based version of the workflow.',
     )
-    parser.add_argument('--gpu', default=False, action='store_true', help='Use the GPU-based version of the workflow.')
     parser.add_argument(
         '--bounds',
         default=None,
         type=str.split,
         nargs='+',
-        help='DEM extent bbox in EPSG:4326: [min_lon, min_lat, max_lon, max_lat].'
+        help='DEM extent bbox in EPSG:4326: [min_lon, min_lat, max_lon, max_lat].',
+    )
+    parser.add_argument(
+        'granules',
+        type=str.split,
+        nargs='+',
+        help='Level-0 S1 granule(s) to back-project.',
     )
-    parser.add_argument('granules', type=str.split, nargs='+', help='Level-0 S1 granule(s) to back-project.')
     args = parser.parse_args()
 
     args.granules = [item for sublist in args.granules for item in sublist]

src/hyp3_srg/dem.py

@@ -1,7 +1,7 @@
 """Prepare a Copernicus GLO-30 DEM virtual raster (VRT) covering a given geometry"""
+
 import logging
 from pathlib import Path
-from typing import Optional
 
 import requests
 
@@ -27,7 +27,7 @@ def ensure_egm_model_available():
                 f.write(chunk)
 
 
-def download_dem_for_srg(bounds: list[float], work_dir: Optional[Path]):
+def download_dem_for_srg(bounds: list[float], work_dir: Path | None):
     """Download the DEM for the given bounds - [min_lon, min_lat, max_lon, max_lat].
 
     Args:
@@ -37,9 +37,9 @@ def download_dem_for_srg(bounds: list[float], work_dir: Optional[Path]):
     Returns:
         The path to the downloaded DEM
     """
-    if (bounds[0] >= bounds[2] or bounds[1] >= bounds[3]):
+    if bounds[0] >= bounds[2] or bounds[1] >= bounds[3]:
         raise ValueError(
-            "Improper bounding box formatting, should be [max latitude, min latitude, min longitude, max longitude]."
+            'Improper bounding box formatting, should be [max latitude, min latitude, min longitude, max longitude].'
         )
 
     dem_path = work_dir / 'elevation.dem'