Merge pull request #252 from ASFHyP3/remove_legacy_option

remove legacy option in the arguments of the prepare_rtc_job and subm…

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

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,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` 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 +288,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 +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` 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