initial version of ipxapi

Author: jpswinski

sliderule/icesat2.py

@@ -275,14 +275,20 @@ def __query_servers(max_workers):
     # Return Number of Workers #
     return max_workers
 
+#
+#  __emptyframe
+#
+def __emptyframe():
+    return geopandas.pd.DataFrame()
+
 #
 #  __todataframe
 #
 def __todataframe(columns, delta_time_key="delta_time", lon_key="lon", lat_ley="lat"):
 
     # Check Empty Columns
     if len(columns) <= 0:
-        return geopandas.pd.DataFrame()
+        return __emptyframe()
 
     # Generate Time Column
     delta_time = (columns[delta_time_key]*1000000.0).astype('timedelta64[us]')
@@ -448,7 +454,7 @@ def __parallelize(max_workers, block, function, parm, resources, *args):
         if len(results) > 0:
             return geopandas.pd.concat(results)
         else:
-            return geopandas.pd.DataFrame()
+            return __emptyframe()
 
     # For Non-Blocking Calls
     else:
@@ -557,20 +563,22 @@ def atl06 (parm, resource, asset="atlas-s3", track=0):
         return __atl06(parm, resource, asset, track)[0]
     except RuntimeError as e:
         logger.critical(e)
-        return {}
+        return __emptyframe()
 
 #
 #  PARALLEL ATL06
 #
-def atl06p(parm, asset="atlas-s3", track=0, max_workers=0, version='004', block=True):
+def atl06p(parm, asset="atlas-s3", track=0, max_workers=0, version='004', block=True, resources=None):
 
     try:
-        resources = __query_resources(parm, version)
+        if resources == None:
+            resources = __query_resources(parm, version)
         max_workers = __query_servers(max_workers)
         return __parallelize(max_workers, block, __atl06, parm, resources, asset, track)
     except RuntimeError as e:
         logger.critical(e)
-        return {}
+        return __emptyframe()
+
 
 #
 #  Subsetted ATL03
@@ -581,20 +589,21 @@ def atl03s (parm, resource, asset="atlas-s3", track=0):
         return __atl03s(parm, resource, asset, track)[0]
     except RuntimeError as e:
         logger.critical(e)
-        return {}
+        return __emptyframe()
 
 #
 #  PARALLEL SUBSETTED ATL03
 #
-def atl03sp(parm, asset="atlas-s3", track=0, max_workers=0, version='004', block=True):
+def atl03sp(parm, asset="atlas-s3", track=0, max_workers=0, version='004', block=True, resources=None):
 
     try:
-        resources = __query_resources(parm, version)
+        if resources == None:
+            resources = __query_resources(parm, version)
         max_workers = __query_servers(max_workers)
         return __parallelize(max_workers, block, __atl03s, parm, resources, asset, track)
     except RuntimeError as e:
         logger.critical(e)
-        return {}
+        return __emptyframe()
 
 #
 #  H5

sliderule/ipxapi.py

@@ -0,0 +1,70 @@
+# Copyright (c) 2021, University of Washington
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# 1. Redistributions of source code must retain the above copyright notice,
+#    this list of conditions and the following disclaimer.
+#
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+#    this list of conditions and the following disclaimer in the documentation
+#    and/or other materials provided with the distribution.
+#
+# 3. Neither the name of the University of Washington nor the names of its
+#    contributors may be used to endorse or promote products derived from this
+#    software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE UNIVERSITY OF WASHINGTON AND CONTRIBUTORS
+# “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
+# TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE UNIVERSITY OF WASHINGTON OR
+# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
+# OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
+# WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
+# OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
+# ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+from sliderule import icesat2
+import logging
+
+###############################################################################
+# GLOBALS
+###############################################################################
+
+# create logger
+logger = logging.getLogger(__name__)
+
+###############################################################################
+# APIs
+###############################################################################
+
+#
+#  ICEPYX ATL06
+#
+def atl06p(ipx_region, parm, asset="atlas-s3",):
+
+    try:
+        version = ipx_region.product_version
+        resources = ipx_region.avail_granules(ids=True)[0]
+    except:
+        logger.critical("must supply an icepyx query as region")
+        return icesat2.__emptyframe()
+
+    return icesat2.atl06p(parm, asset, version=version, resources=resources)
+
+#
+#  ICEPYX ATL03
+#
+def atl03sp(ipx_region, parm, asset="atlas-s3"):
+
+    try:
+        version = ipx_region.product_version
+        resources = ipx_region.avail_granules(ids=True)[0]
+    except:
+        logger.critical("must supply an icepyx query as region")
+        return icesat2.__emptyframe()
+
+    return icesat2.atl03sp(parm, asset, version=version, resources=resources)

utils/icepx_region.py

@@ -0,0 +1,92 @@
+import sys
+from datetime import date
+from sliderule import ipxapi
+from sliderule import icesat2
+import icepyx
+
+###############################################################################
+# LOCAL FUNCTIONS
+###############################################################################
+
+def parse_command_line(args, cfg):
+    i = 1
+    while i < len(args):
+        for entry in cfg:
+            if args[i] == '--'+entry:
+                if type(cfg[entry]) is str:
+                    cfg[entry] = args[i + 1]
+                elif type(cfg[entry]) is list:
+                    l = []
+                    while (i + 1) < len(args) and args[i + 1].isnumeric():
+                        l.append(int(args[i + 1]))
+                        i += 1
+                    cfg[entry] = l
+                elif type(cfg[entry]) is int:
+                    cfg[entry] = int(args[i + 1])
+                i += 1
+        i += 1
+    return cfg
+
+###############################################################################
+# MAIN
+###############################################################################
+
+if __name__ == '__main__':
+
+    today = date.today()
+
+    # set script defaults
+    scfg = {
+        "url": ['127.0.0.1'],
+        "asset": 'atlas-local'
+    }
+
+    # set icepx defaults
+    icfg = {
+        "short_name": 'ATL03',
+        "spatial_extent": 'valgrande.shp',
+        "date_range": ['2018-01-01', "{}-{}-{}".format(today.year, today.month, today.day)],
+        "cycles": [],
+        "tracks": []
+    }
+
+    # set processing parameter defaults
+    parms = {
+        "srt": icesat2.SRT_LAND,
+        "cnf": icesat2.CNF_SURFACE_HIGH,
+        "ats": 10.0,
+        "cnt": 10,
+        "len": 40.0,
+        "res": 20.0,
+        "maxi": 1
+    }
+
+    # get command line parameters
+    parse_command_line(sys.argv, icfg)
+    parse_command_line(sys.argv, scfg)
+    parse_command_line(sys.argv, parms)
+
+    # massage command line parameters
+    if len(icfg["cycles"]) == 0:
+        icfg["cycles"] = None
+    if len(icfg["tracks"]) == 0:
+        icfg["tracks"] = None
+
+    # create icepx region
+    iregion = icepyx.Query(icfg["short_name"], icfg["spatial_extent"], icfg["date_range"], cycles=icfg["cycles"], tracks=icfg["tracks"])
+
+    # visualize icepx region
+    iregion.visualize_spatial_extent()
+
+    # display summary information
+    iregion.product_summary_info()
+    print("Available Granules:", iregion.avail_granules())
+    print("Available Granule IDs:", iregion.avail_granules(ids=True))
+
+    # initialize sliderule api
+    icesat2.init(scfg["url"], verbose=True)
+
+    # generate sliderule atl06 elevations
+    parms["poly"] = icesat2.toregion(icfg["spatial_extent"])
+    ipxapi.atl06p(iregion, parms, scfg["asset"])
+