add NISAR support to ARIA-download (#480)

* add NISAR support to ARIA-download, update readme and requirement files.

Author: dbekaert

README.md

@@ -2,7 +2,7 @@
 [![Language](https://img.shields.io/badge/python-3.9%2B-blue.svg)](https://www.python.org/)
 [![License](https://img.shields.io/badge/License-Apache_2.0-green.svg)](https://github.com/aria-tools/ARIA-tools/blob/master/LICENSE)
 
-ARIA-tools is an open-source package in Python which contains tools to manipulate standard InSAR products from Sentinel-1 (ARIA GUNW-S1) and NISAR (NISAR_L2_PR_GUNW). This software is open source under the terms of the [Apache 2.0 License](LICENSE). Its development was funded under the ROSES awards from the NASA Sea-level Change Team (NSLCT) program, the Earth Surface and Interior (ESI) program, and under the NISAR Science Team (NISAR-ST) program.
+ARIA-tools is an open-source package in Python which contains tools to manipulate standard InSAR products from Sentinel-1 (ARIA GUNW-S1) and NISAR (NISAR_L2_GUNW). This software is open source under the terms of the [Apache 2.0 License](LICENSE). Its development was funded under the ROSES awards from the NASA Sea-level Change Team (NSLCT) program, the Earth Surface and Interior (ESI) program, and under the NISAR Science Team (NISAR-ST) program.
 
 
 > [!IMPORTANT]
@@ -13,7 +13,7 @@ ARIA-tools is an open-source package in Python which contains tools to manipulat
 
 ARIA tools includes support for:
 - ARIA Geocoded Unwrapped Interferogram from Sentinel-1 (GUNW-S1) can be downloaded for free from the [ASF DAAC vertex page](https://search.asf.alaska.edu/#/?dataset=SENTINEL-1%20INTERFEROGRAM%20(BETA)) selecting "ARIA S1 GUNW" under "datasets".  Users can also request free on-demand products through the [ASF on-demand system](https://hyp3-docs.asf.alaska.edu/guides/gunw_product_guide/). These products are added to the standard product archive. A log-on using the NASA Earthdata credentials is required to order new or download data from the archive. [Product Specification Document](https://hyp3-docs.asf.alaska.edu/guides/gunw_product_guide/#product-packaging).
--  NISAR Gecoded Unwrapped Interferogram products (NISAR_L2_PR_GUNW) can be downloaded for free from the [ASF DAAC vertex page](https://search.asf.alaska.edu/#/?dataset=NISAR&prodConfig=PR&sciProducts=GUNW) selecting "NISAR" under "datasets" and selecting "GUNW" under the filter criteria. [Product Specification document](https://nisar-docs.asf.alaska.edu/gunw/). 
+-  NISAR Gecoded Unwrapped Interferogram products (NISAR_L2_GUNW) can be downloaded for free from the [ASF DAAC vertex page](https://search.asf.alaska.edu/#/?dataset=NISAR&prodConfig=PR&sciProducts=GUNW) selecting "NISAR" under "datasets" and selecting "GUNW" under the filter criteria. [Product Specification document](https://nisar-docs.asf.alaska.edu/gunw/). 
 
 
 The ARIA-tools package includes functionality to crop/merge data and meta-data layers for multiple standard products, extraction of data and meta-data layers from these products, and the set-up and the preparation for time-series. 
@@ -62,7 +62,7 @@ Below we list the key dependencies for ARIA-tools. See environment.yml for compl
 * [SciPy](https://www.scipy.org/)
 * [netcdf4](http://unidata.github.io/netcdf4-python/netCDF4/index.html)
 * [requests](https://2.python-requests.org/en/master/)
-* [asf_search](https://github.com/asfadmin/Discovery-asf_search) >=10.0.4
+* [asf_search](https://github.com/asfadmin/Discovery-asf_search) >=12.0.1
 ```
 
 ### Optional Python Jupyter dependencies
@@ -194,16 +194,16 @@ The ARIA-tools scripts are highly modulized in Python and therefore allows for b
 
 
 ### Commandline download of GUNW Products
-ARIA GUNW-S1 products can be downloaded through the commandline using the *ariaDownload.py* program, which wraps around the ASF DAAC api.
+ARIA GUNW-S1/NISAR_L2_GUNW products can be downloaded through the commandline using the *ariaDownload.py* program, which wraps around the ASF DAAC api.
 
 ### Manipulating GUNW Products
-ARIA GUNW-S1/NISAR_L2_PR_GUNW products can be manipulated (cropped, stitched, extracted) using the *ariaExtract.py* program. 
+ARIA GUNW-S1/NISAR_L2_GUNW products can be manipulated (cropped, stitched, extracted) using the *ariaExtract.py* program. 
 
 ### Baseline and quality control plots for GUNW Products
 ARIA GUNW-S1 quality and baseline plots for spatial-temporal contiguous interferograms can be made using the *ariaPlot.py* program.
 
 ### Time-series set-up of GUNW Products
-ARIA GUNW-S1/NISAR_L2_PR_GUNW time-series set-up with spatial-temporal contiguous unwrapped interferograms and coherence can be done using the *ariaTSsetup.py* program.
+ARIA GUNW-S1/NISAR_L2_GUNW time-series set-up with spatial-temporal contiguous unwrapped interferograms and coherence can be done using the *ariaTSsetup.py* program.
 
 > [!NOTE]  
 > We support extraction of correction layers (e.g. Troposphere, Ionosphere, Solid Earth Tides) as well as geometry information (e.g. incidence angle, look angle, baselines, etc) embeded within the GUNW products 

environment.yml

@@ -9,7 +9,7 @@ channels:
 dependencies:
   - affine
   - arm_pyart
-  - asf_search>=10.0.4
+  - asf_search>=12.0.1
   - dask
   - dem_stitcher>=2.5.8
   - gdal>=3.7.0

requirements.txt

@@ -1,6 +1,6 @@
 affine
 arm_pyart
-asf_search>=10.0.4
+asf_search>=12.0.1
 dask
 dem_stitcher>=2.5.8
 gdal>=3.7.0

tools/bin/ariaDownload.py

@@ -38,17 +38,31 @@ def createParser():
     parser = argparse.ArgumentParser(
         description='Command line interface to download Sentinel-1/NISAR '
                     'GUNW products from the ASF DAAC. \nDownloading them '
-                    'requires a NASA Earthdata URS user login and requires '
-                    'users to add "GRFN Door (PROD)" and "ASF Datapool '
-                    'Products" to their URS approved applications. Access '
-                    'to NISAR products requires an Earthdata Bearer token '
-                    'from: https://urs.earthdata.nasa.gov/documentation/'
-                    'for_users/user_token',
-        epilog='Examples of use:\n'
-               '\t ariaDownload.py --track 004 --output count\n'
-               '\t ariaDownload.py --bbox "36.75 37.225 -76.655 -75.928"\n'
-               '\t ariaDownload.py -t 004,077 --start 20190101 -o count'
-               '\t ariaDownload.py --mission NISAR -o count',
+                    'requires a NASA Earthdata URS user login',
+        epilog='Examples of use:\n\n'
+                '\t # Count Sentinel-1 products available for track 004\n'
+                '\t ariaDownload.py --track 004 --output count\n\n'
+                '\t # Download Sentinel-1 products within specified '
+                'bounding box\n'
+                '\t ariaDownload.py --bbox "36.75 37.225 -76.655 '
+                '-75.928"\n\n'
+                '\t # Count Sentinel-1 products for tracks 004 & 077 '
+                'since Jan 2019\n'
+                '\t ariaDownload.py --mission S1 -t 004,077 '
+                '--start 20190101 -o count\n\n'
+                '\t # Count all available NISAR products\n'
+                '\t ariaDownload.py --mission NISAR -o count\n\n'
+                '\t # Download globally available descending NISAR '
+                'products\n'
+                '\t ariaDownload.py --mission NISAR -d d '
+                '-b "-90 90 -180 180"\n\n'
+                '\t # Count all available NISAR products for track 172\n'
+                '\t ariaDownload.py --mission NISAR -t 172 -o count\n\n'
+                '\t # Download specific NISAR interferogram '
+                'and query the globe for it\n'
+                '\t ariaDownload.py --mission NISAR '
+                '-b "-90 90 -180 180" -i 20251122_20251204\n',
+        
         formatter_class=argparse.RawDescriptionHelpFormatter)
 
     parser.add_argument(
@@ -58,33 +72,29 @@ def createParser():
              'aria*.py')
     parser.add_argument(
         '-t', '--track', default=None, type=str,
-        help='track to download; single number (including leading zeros) or '
+        help='track to download; single number or '
              'comma separated')
     parser.add_argument(
-        '-b', '--bbox', default=None, type=str,
+        '-b', '--bbox', default="-90 90 -180 180", type=str,
         help='Lat/Lon Bounding SNWE, or GDAL-readable file containing '
-             'POLYGON geometry.')
+             'POLYGON geometry. Default is set to global scale')
     parser.add_argument(
         '-w', '--workdir', dest='wd', default='./products', type=str,
         help='Specify directory to deposit all outputs. Default is "products" '
              'in local directory where script is launched.')
     parser.add_argument(
         '-s', '--start', default='20100101', type=str,
         help='Start date as YYYYMMDD; If none provided, starts at beginning '
-             'of beta NISAR GUNW record (2010).')
+             'of 2010.')
     parser.add_argument(
         '-e', '--end', default='21000101', type=str,
         help='End date as YYYYMMDD. If none provided, ends today.')
     parser.add_argument(
         '-u', '--user', default=None, type=str,
-        help='NASA Earthdata URS user login. Users must add "GRFN Door '
-             '(PROD)" and "ASF Datapool Products" to their URS approved '
-             'applications.')
+        help='NASA Earthdata URS user login.')
     parser.add_argument(
         '-p', '--pass', dest='passw', default=None, type=str,
-        help='NASA Earthdata URS user password. Users must add "GRFN Door '
-             '(PROD)" and "ASF Datapool Products" to their URS approved '
-             'applications.')
+        help='NASA Earthdata URS user password.')
     parser.add_argument(
         '--mission', default='S1', type=str.upper, choices=('S1', 'NISAR'),
         help='Sentinel-1 (S1) or NISAR. Default is S1')
@@ -105,15 +115,16 @@ def createParser():
     parser.add_argument(
         '-i', '--ifg', default=None, type=str,
         help='Retrieve one interferogram by its start/end date, specified as '
-             'YYYYMMDD_YYYYMMDD (order independent)')
+             'YYYYMMDD_YYYYMMDD (order independent).')
     parser.add_argument(
         '-d', '--direction', dest='flightdir', default=None, type=str,
         help='Flight direction, options: ascending, a, descending, d')
     parser.add_argument(
         '--version', default=None,
         help='Specify version as str, e.g. 2_0_4 or all prods. All products '
              'are downloaded by default. If version is specified, only '
-             'products which match that version are downloaded.')
+             'products which match that version are downloaded. '
+             'Not supported for NISAR currently.')
     parser.add_argument(
         '-v', '--verbose', action='store_true',
         help='Print products to be downloaded to stdout')
@@ -175,7 +186,7 @@ def get_url_ifg(scenes):
         else:
             f = s['fileID'].split('-')
             pairname = f[6]
-        ifgs.append(pairname)
+            ifgs.append(pairname)
 
     # determine if NISAR GUNW
     is_nisar_file = False
@@ -231,7 +242,12 @@ def __call__(self):
         urls, ifgs, is_nisar_file = get_url_ifg(scenes)
 
         # Subset everything by version
-        urls = url_versions(urls, self.args.version, self.args.wd)
+        if is_nisar_file and self.args.version is not None:
+            raise Exception(
+                'Version support not included for NISAR, remove the critera'
+            )
+        else:
+            urls = url_versions(urls, self.args.version, self.args.wd)
         scenes = [scene for scene, url in zip(scenes, urls) if url in urls]
         ifgs = [ifg for ifg, url in zip(ifgs, urls) if url in urls]
 
@@ -242,14 +258,15 @@ def __call__(self):
             ifgs,
             is_nisar_file
         )
+        
 
         if self.args.output == "Count":
             LOGGER.info("Found -- %d -- products", len(scenes))
         elif self.args.output == "Url":
             self.write_urls(urls)
         elif self.args.output == "Download":
             self.download_scenes(scenes)
-
+            
         if self.args.verbose:
             for scene in scenes:
                 LOGGER.info(scene.geojson()["properties"]["sceneName"])
@@ -288,27 +305,22 @@ def query_asf(self):
                 end=end,
             )
         elif self.args.mission.upper() == "NISAR":
-            session = asf_search.ASFSession()
-            session.auth_with_token(getpass.getpass("EDL Token:"))
-            LOGGER.info("Token accepted.")
-
-            search_opts = asf_search.ASFSearchOptions(
-                shortName="NISAR_L2_GUNW_BETA_V1",
+            return asf_search.geo_search(
+                collections=["C2850261892-ASF"],
+                dataset=asf_search.constants.NISAR,
+                processingLevel=asf_search.constants.GUNW,
+                relativeOrbit=tracks,
+                flightDirection=flight_direction,
                 intersectsWith=bbox_wkt,
                 start=start,
                 end=end,
-                session=session,
             )
-            scenes = asf_search.search(opts=search_opts, maxResults=250)
-
-            LOGGER.info("Found %d NISAR GUNW Betas.", len(scenes))
-            return scenes
 
     def filter_scenes(self, scenes, urls, ifgs, is_nisar_file):
         filtered_scenes, filtered_urls, filtered_ifgs = [], [], []
+
         for scene, url, ifg in zip(scenes, urls, ifgs):
             eni, sti = self.parse_dates(ifg, is_nisar_file)
-
             if self.args.ifg:
                 if self.match_single_ifg(sti, eni):
                     filtered_scenes.append(scene)
@@ -318,7 +330,6 @@ def filter_scenes(self, scenes, urls, ifgs, is_nisar_file):
                 filtered_scenes.append(scene)
                 filtered_urls.append(url)
                 filtered_ifgs.append(ifg)
-
         return filtered_scenes, filtered_urls, filtered_ifgs
 
     def parse_dates(self, ifg, is_nisar_file):
@@ -442,7 +453,7 @@ def main():
     args.start = datetime.datetime.strptime(args.start, '%Y%m%d')
     args.end = datetime.datetime.strptime(args.end, '%Y%m%d')
 
-    if not args.track and not args.bbox and args.mission.upper() != 'NISAR':
+    if not args.track and not args.bbox:
         raise Exception('Must specify either a bbox or track')
     Downloader(args)()