From 6d1d2cccfc171c81a1299dda2a9d1dba432093c6 Mon Sep 17 00:00:00 2001 From: jiangzhu Date: Thu, 21 Dec 2023 15:07:32 -0900 Subject: [PATCH 1/6] remove legacy option in the arguments of the prepare_rtc_job and submit_rtc_job functions --- src/hyp3_sdk/hyp3.py | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/src/hyp3_sdk/hyp3.py b/src/hyp3_sdk/hyp3.py index f23d1c2..7c2adc7 100644 --- a/src/hyp3_sdk/hyp3.py +++ b/src/hyp3_sdk/hyp3.py @@ -247,7 +247,7 @@ def submit_rtc_job(self, resolution: Literal[10, 20, 30] = 30, scale: Literal['amplitude', 'decibel', 'power'] = 'power', speckle_filter: bool = False, - dem_name: Literal['copernicus', 'legacy'] = 'copernicus') -> Batch: + dem_name: Literal['copernicus'] = 'copernicus') -> Batch: """Submit an RTC job Args: @@ -264,8 +264,7 @@ def submit_rtc_job(self, resolution: Desired output pixel spacing in meters scale: Scale of output image; power, decibel or amplitude speckle_filter: Apply an Enhanced Lee speckle filter - dem_name: Name of the DEM to use for processing. `copernicus` will use the Copernicus GLO-30 Public DEM, - while `legacy` will use the DEM with the best coverage from ASF's legacy SRTM/NED datasets. + dem_name: Name of the DEM to use for processing. `copernicus` is the only option, and it will use the Copernicus GLO-30 Public DEM. Returns: A Batch object containing the RTC job @@ -288,7 +287,7 @@ def prepare_rtc_job(cls, resolution: Literal[10, 20, 30] = 30, scale: Literal['amplitude', 'decibel', 'power'] = 'power', speckle_filter: bool = False, - dem_name: Literal['copernicus', 'legacy'] = 'copernicus') -> dict: + dem_name: Literal['copernicus'] = 'copernicus') -> dict: """Submit an RTC job Args: @@ -305,8 +304,7 @@ def prepare_rtc_job(cls, resolution: Desired output pixel spacing in meters scale: Scale of output image; power, decibel or amplitude speckle_filter: Apply an Enhanced Lee speckle filter - dem_name: Name of the DEM to use for processing. `copernicus` will use the Copernicus GLO-30 Public DEM, - while `legacy` will use the DEM with the best coverage from ASF's legacy SRTM/NED datasets. + dem_name: Name of the DEM to use for processing. `copernicus` is the only option, and it will use the Copernicus GLO-30 Public DEM. Returns: A dictionary containing the prepared RTC job From e22e2e81aa9141b590fcb4aa0e02d20bd7ef6caf Mon Sep 17 00:00:00 2001 From: jiangzhu Date: Thu, 21 Dec 2023 15:13:10 -0900 Subject: [PATCH 2/6] code style --- src/hyp3_sdk/hyp3.py | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/src/hyp3_sdk/hyp3.py b/src/hyp3_sdk/hyp3.py index 7c2adc7..1220e7a 100644 --- a/src/hyp3_sdk/hyp3.py +++ b/src/hyp3_sdk/hyp3.py @@ -264,7 +264,8 @@ def submit_rtc_job(self, resolution: Desired output pixel spacing in meters scale: Scale of output image; power, decibel or amplitude speckle_filter: Apply an Enhanced Lee speckle filter - dem_name: Name of the DEM to use for processing. `copernicus` is the only option, and it will use the Copernicus GLO-30 Public DEM. + dem_name: Name of the DEM to use for processing. `copernicus` is the only option, and it will use + the Copernicus GLO-30 Public DEM. Returns: A Batch object containing the RTC job @@ -304,7 +305,8 @@ def prepare_rtc_job(cls, resolution: Desired output pixel spacing in meters scale: Scale of output image; power, decibel or amplitude speckle_filter: Apply an Enhanced Lee speckle filter - dem_name: Name of the DEM to use for processing. `copernicus` is the only option, and it will use the Copernicus GLO-30 Public DEM. + dem_name: Name of the DEM to use for processing. `copernicus` is the only option, and it will use + the Copernicus GLO-30 Public DEM. Returns: A dictionary containing the prepared RTC job From e2777a97824735d60003396b20ebc5cce827b126 Mon Sep 17 00:00:00 2001 From: jiangzhu Date: Thu, 21 Dec 2023 15:18:30 -0900 Subject: [PATCH 3/6] update the CHANGELOG.md --- CHANGELOG.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 918b30d..0b4da26 100644 --- 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). +## [4.0.1] +### Removed +* Legacy option in the dem_name argument of prepare_rtc_job and submit_rtc_job functions in hyp3.py. + ## [4.0.0] ### Added * The HyP3 SDK now explicitly supports Python 3.9-3.12 From 7259701f5032e2392c2a4c36e46cb00016a643a7 Mon Sep 17 00:00:00 2001 From: cirrusasf <62269400+cirrusasf@users.noreply.github.com> Date: Fri, 22 Dec 2023 09:51:08 -0900 Subject: [PATCH 4/6] Update src/hyp3_sdk/hyp3.py Co-authored-by: Forrest Williams <31411324+forrestfwilliams@users.noreply.github.com> --- src/hyp3_sdk/hyp3.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/hyp3_sdk/hyp3.py b/src/hyp3_sdk/hyp3.py index 1220e7a..292b938 100644 --- a/src/hyp3_sdk/hyp3.py +++ b/src/hyp3_sdk/hyp3.py @@ -305,7 +305,7 @@ def prepare_rtc_job(cls, resolution: Desired output pixel spacing in meters scale: Scale of output image; power, decibel or amplitude speckle_filter: Apply an Enhanced Lee speckle filter - dem_name: Name of the DEM to use for processing. `copernicus` is the only option, and it will use + dem_name: Name of the DEM to use for processing. `copernicus` is the only option, and it will use the Copernicus GLO-30 Public DEM. Returns: From 749f34a4c6140dc6c82de72a1ef83ab84d0109ec Mon Sep 17 00:00:00 2001 From: cirrusasf <62269400+cirrusasf@users.noreply.github.com> Date: Fri, 22 Dec 2023 09:51:35 -0900 Subject: [PATCH 5/6] Update src/hyp3_sdk/hyp3.py Co-authored-by: Forrest Williams <31411324+forrestfwilliams@users.noreply.github.com> --- src/hyp3_sdk/hyp3.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/hyp3_sdk/hyp3.py b/src/hyp3_sdk/hyp3.py index 292b938..84d9abf 100644 --- a/src/hyp3_sdk/hyp3.py +++ b/src/hyp3_sdk/hyp3.py @@ -264,7 +264,7 @@ def submit_rtc_job(self, resolution: Desired output pixel spacing in meters scale: Scale of output image; power, decibel or amplitude speckle_filter: Apply an Enhanced Lee speckle filter - dem_name: Name of the DEM to use for processing. `copernicus` is the only option, and it will use + dem_name: Name of the DEM to use for processing. `copernicus` is the only option, and it will use the Copernicus GLO-30 Public DEM. Returns: From 4550892c3e62e4165e2c0ee3434d4aba9f4f1583 Mon Sep 17 00:00:00 2001 From: cirrusasf <62269400+cirrusasf@users.noreply.github.com> Date: Fri, 22 Dec 2023 09:51:59 -0900 Subject: [PATCH 6/6] Update CHANGELOG.md Co-authored-by: Forrest Williams <31411324+forrestfwilliams@users.noreply.github.com> --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 0b4da26..623b951 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -8,7 +8,7 @@ and uses [Semantic Versioning](https://semver.org/spec/v2.0.0.html). ## [4.0.1] ### Removed -* Legacy option in the dem_name argument of prepare_rtc_job and submit_rtc_job functions in hyp3.py. +* Legacy option in the `dem_name` argument of `prepare_rtc_job` and `submit_rtc_job` functions in hyp3.py. ## [4.0.0] ### Added