Merge pull request #357 from ASFHyP3/develop

asjohnston-asf · web-flow · commit 6fd41e217f02 · 2025-06-17T14:53:26.000-08:00
Release v7.6.0
diff --git a/.github/workflows/changelog.yml b/.github/workflows/changelog.yml
@@ -12,4 +12,4 @@ on:
 
 jobs:
   call-changelog-check-workflow:
-    uses: ASFHyP3/actions/.github/workflows/reusable-changelog-check.yml@v0.19.0
+    uses: ASFHyP3/actions/.github/workflows/reusable-changelog-check.yml@v0.20.0
diff --git a/.github/workflows/create-jira-issue.yml b/.github/workflows/create-jira-issue.yml
@@ -6,7 +6,7 @@ on:
 
 jobs:
   call-create-jira-issue-workflow:
-    uses: ASFHyP3/actions/.github/workflows/reusable-create-jira-issue.yml@v0.19.0
+    uses: ASFHyP3/actions/.github/workflows/reusable-create-jira-issue.yml@v0.20.0
     secrets:
       JIRA_BASE_URL: ${{ secrets.JIRA_BASE_URL }}
       JIRA_USER_EMAIL: ${{ secrets.JIRA_USER_EMAIL }}
diff --git a/.github/workflows/distribute.yml b/.github/workflows/distribute.yml
@@ -7,7 +7,7 @@ on:
 
 jobs:
   call-version-info-workflow:
-    uses: ASFHyP3/actions/.github/workflows/reusable-version-info.yml@v0.19.0
+    uses: ASFHyP3/actions/.github/workflows/reusable-version-info.yml@v0.20.0
     with:
       python_version: "3.10"
 
diff --git a/.github/workflows/labeled-pr.yml b/.github/workflows/labeled-pr.yml
@@ -12,4 +12,4 @@ on:
 
 jobs:
   call-labeled-pr-check-workflow:
-    uses: ASFHyP3/actions/.github/workflows/reusable-labeled-pr-check.yml@v0.19.0
+    uses: ASFHyP3/actions/.github/workflows/reusable-labeled-pr-check.yml@v0.20.0
diff --git a/.github/workflows/release-template-comment.yml b/.github/workflows/release-template-comment.yml
@@ -7,7 +7,7 @@ on:
 
 jobs:
   call-release-workflow:
-    uses: ASFHyP3/actions/.github/workflows/reusable-release-checklist-comment.yml@v0.19.0
+    uses: ASFHyP3/actions/.github/workflows/reusable-release-checklist-comment.yml@v0.20.0
     permissions:
       pull-requests: write
     secrets:
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -7,7 +7,7 @@ on:
 
 jobs:
   call-release-workflow:
-    uses: ASFHyP3/actions/.github/workflows/reusable-release.yml@v0.19.0
+    uses: ASFHyP3/actions/.github/workflows/reusable-release.yml@v0.20.0
     with:
       release_prefix: HyP3 SDK
     secrets:
diff --git a/.github/workflows/static-analysis.yml b/.github/workflows/static-analysis.yml
@@ -8,12 +8,12 @@ on: push
 jobs:
   call-secrets-analysis-workflow:
     # Docs: https://github.com/ASFHyP3/actions
-    uses: ASFHyP3/actions/.github/workflows/reusable-secrets-analysis.yml@v0.19.0
+    uses: ASFHyP3/actions/.github/workflows/reusable-secrets-analysis.yml@v0.20.0
 
   call-ruff-workflow:
     # Docs: https://github.com/ASFHyP3/actions
-    uses: ASFHyP3/actions/.github/workflows/reusable-ruff.yml@v0.19.0
+    uses: ASFHyP3/actions/.github/workflows/reusable-ruff.yml@v0.20.0
 
   call-mypy-workflow:
     # Docs: https://github.com/ASFHyP3/actions
-    uses: ASFHyP3/actions/.github/workflows/reusable-mypy.yml@v0.19.0
+    uses: ASFHyP3/actions/.github/workflows/reusable-mypy.yml@v0.20.0
diff --git a/.github/workflows/tag-version.yml b/.github/workflows/tag-version.yml
@@ -9,6 +9,6 @@ jobs:
   call-bump-version-workflow:
     # For first-time setup, create a v0.0.0 tag as shown here:
     # https://github.com/ASFHyP3/actions#reusable-bump-versionyml
-    uses: ASFHyP3/actions/.github/workflows/reusable-bump-version.yml@v0.19.0
+    uses: ASFHyP3/actions/.github/workflows/reusable-bump-version.yml@v0.20.0
     secrets:
       USER_TOKEN: ${{ secrets.TOOLS_BOT_PAK }}
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -12,7 +12,7 @@ on:
 
 jobs:
   call-pytest-workflow:
-    uses: ASFHyP3/actions/.github/workflows/reusable-pytest.yml@v0.19.0
+    uses: ASFHyP3/actions/.github/workflows/reusable-pytest.yml@v0.20.0
     with:
       local_package_name: hyp3_sdk
       python_versions: >-
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,10 @@ 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).
 
+## [7.6.0]
+### Changed
+* `ARIA-S1-GUNW` jobs now uses `reference_date` and `secondary_date` as input instead of a list of granules
+
 ## [7.5.0]
 
 ### Added
diff --git a/README.md b/README.md
@@ -67,7 +67,7 @@ insar_job = hyp3.submit_insar_job('reference_granule_id', 'secondary_granule_id'
 insar_burst_job = hyp3.submit_insar_isce_burst_job('reference_granule_id', 'secondary_granule_id', 'job_name')
 insar_multi_burst_job = hyp3.submit_insar_isce_multi_burst_job(['ref_id_1', 'ref_id_2'], ['sec_id_1', 'sec_id_2'], 'job_name')
 autorift_job = hyp3.submit_autorift_job('reference_granule_id', 'secondary_granule_id', 'job_name')
-aria_s1_gunw_job = hyp3.submit_aria_s1_gunw_job(['ref_id_1', 'ref_id_2'], ['sec_id_1', 'sec_id_2'], 'frame_id', 'job_name')
+aria_s1_gunw_job = hyp3.submit_aria_s1_gunw_job('ref_date', 'sec_date', 'frame_id', 'job_name')
 opera_rtc_s1_job = hyp3.submit_opera_rtc_s1_job('granule_id')
 ```
 Each of these functions will return an instance of the `Job` class that represents a new HyP3 job request.
diff --git a/requirements-static.txt b/requirements-static.txt
@@ -1,2 +1,2 @@
-ruff==0.11.10
-mypy==1.15.0
+ruff==0.11.13
+mypy==1.16.0
diff --git a/src/hyp3_sdk/hyp3.py b/src/hyp3_sdk/hyp3.py
@@ -572,13 +572,13 @@ def prepare_insar_isce_burst_job(
         return job_dict
 
     def submit_aria_s1_gunw_job(
-        self, reference: list[str], secondary: list[str], frame_id: int, name: str | None = None
+        self, reference_date: str, secondary_date: str, frame_id: int, name: str | None = None
     ) -> Batch:
         """Submit an ARIA S1 GUNW job.
 
         Args:
-            reference: The names of the Sentinel-1 SLC granules to use as reference scenes for InSAR processing
-            secondary: The names of the Sentinel-1 SLC granules to use as secondary scenes for InSAR processing
+            reference_date: Date of reference scenes for InSAR processing in YYYY-MM-DD format
+            secondary_date: Date of secondary scenes for InSAR processing in YYYY-MM-DD format
             frame_id: Subset GUNW products to this frame
             name: A name for the job (optional)
 
@@ -592,25 +592,25 @@ def submit_aria_s1_gunw_job(
 
     @classmethod
     def prepare_aria_s1_gunw_job(
-        cls, reference: list[str], secondary: list[str], frame_id: int, name: str | None = None
+        cls, reference_date: str, secondary_date: str, frame_id: int, name: str | None = None
     ) -> dict:
         """Prepare an ARIA S1 GUNW job.
 
         Args:
-            reference: The names of the Sentinel-1 SLC granules to use as reference scenes for InSAR processing
-            secondary: The names of the Sentinel-1 SLC granules to use as secondary scenes for InSAR processing
+            reference_date: Date of reference scenes for InSAR processing in YYYY-MM-DD format
+            secondary_date: Date of secondary scenes for InSAR processing in YYYY-MM-DD format
             frame_id: Subset GUNW products to this frame
             name: A name for the job
 
         Returns:
             A dictionary containing the prepared ARIA S1 GUNW job
         """
         job_parameters = locals().copy()
-        for key in ['cls', 'reference', 'secondary', 'frame_id', 'name']:
+        for key in ['cls', 'name']:
             job_parameters.pop(key)
 
         job_dict = {
-            'job_parameters': {'reference': reference, 'secondary': secondary, 'frame_id': frame_id, **job_parameters},
+            'job_parameters': job_parameters,
             'job_type': 'ARIA_S1_GUNW',
         }
         if name is not None:
diff --git a/tests/test_hyp3.py b/tests/test_hyp3.py
@@ -364,28 +364,26 @@ def test_prepare_opera_rtc_s1_job():
 
 
 def test_prepare_aria_s1_gunw_job():
-    assert HyP3.prepare_aria_s1_gunw_job(
-        reference=['ref_granule1', 'ref_granule2'], secondary=['sec_granule1', 'sec_granule2'], frame_id=100
-    ) == {
+    assert HyP3.prepare_aria_s1_gunw_job(reference_date='ref_date_1', secondary_date='sec_date_1', frame_id=100) == {
         'job_type': 'ARIA_S1_GUNW',
         'job_parameters': {
-            'reference': ['ref_granule1', 'ref_granule2'],
-            'secondary': ['sec_granule1', 'sec_granule2'],
+            'reference_date': 'ref_date_1',
+            'secondary_date': 'sec_date_1',
             'frame_id': 100,
         },
     }
     assert HyP3.prepare_aria_s1_gunw_job(
-        reference=['ref_granule1', 'ref_granule2'],
-        secondary=['sec_granule1', 'sec_granule2'],
-        frame_id=100,
+        reference_date='ref_date_2',
+        secondary_date='sec_date_2',
+        frame_id=101,
         name='my_name',
     ) == {
         'job_type': 'ARIA_S1_GUNW',
         'name': 'my_name',
         'job_parameters': {
-            'reference': ['ref_granule1', 'ref_granule2'],
-            'secondary': ['sec_granule1', 'sec_granule2'],
-            'frame_id': 100,
+            'reference_date': 'ref_date_2',
+            'secondary_date': 'sec_date_2',
+            'frame_id': 101,
         },
     }
 
@@ -454,13 +452,11 @@ def test_submit_insar_isce_multi_burst_job(get_mock_hyp3, get_mock_job):
 
 @responses.activate
 def test_submit_aria_s1_gunw_job(get_mock_hyp3, get_mock_job):
-    job = get_mock_job(
-        'ARIA_S1_GUNW', job_parameters={'reference': ['g1', 'g2'], 'secondary': ['g1', 'g2'], 'frame_id': 100}
-    )
+    job = get_mock_job('ARIA_S1_GUNW', job_parameters={'reference_date': 'd1', 'secondary_date': 'd2', 'frame_id': 100})
     api_response = {'jobs': [job.to_dict()]}
     api = get_mock_hyp3()
     responses.add(responses.POST, urljoin(api.url, '/jobs'), json=api_response)
-    batch = api.submit_aria_s1_gunw_job(['g1', 'g2'], ['g1', 'g2'], 100)
+    batch = api.submit_aria_s1_gunw_job('d1', 'd2', 100)
     assert batch.jobs[0] == job
 
 
