[GitHub] ntquach closed pull request #12: SDAP-47 Update NEXUS CLI to support datainbounds algorithm

[GitBox <gi...@apache.org>]

ntquach closed pull request #12: SDAP-47 Update NEXUS CLI to support datainbounds algorithm
URL: https://github.com/apache/incubator-sdap-nexus/pull/12
 
 
   

This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:

As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):

diff --git a/client/nexuscli/__init__.py b/client/nexuscli/__init__.py
index d6deec9..250b474 100644
--- a/client/nexuscli/__init__.py
+++ b/client/nexuscli/__init__.py
@@ -18,3 +18,4 @@
 from nexuscli.nexuscli import time_series
 from nexuscli.nexuscli import dataset_list
 from nexuscli.nexuscli import daily_difference_average
+from nexuscli.nexuscli import subset
diff --git a/client/nexuscli/nexuscli.py b/client/nexuscli/nexuscli.py
index 9bf51e6..b542dba 100644
--- a/client/nexuscli/nexuscli.py
+++ b/client/nexuscli/nexuscli.py
@@ -43,6 +43,15 @@
 __pdoc__['TimeSeries.minimum'] = "`numpy` array containing minimums"
 __pdoc__['TimeSeries.maximum'] = "`numpy` array containing maximums"
 
+Point = namedtuple('Point', ('time', 'latitude', 'longitude', 'variable'))
+Point.__doc__ = '''\
+An object containing Point attributes.
+'''
+__pdoc__['Point.time'] = "time value as `datetime` object"
+__pdoc__['Point.latitude'] = "latitude value"
+__pdoc__['Point.longitude'] = "longitude value"
+__pdoc__['Point.variable'] = "dictionary of variable values"
+
 ISO_FORMAT = "%Y-%m-%dT%H:%M:%SZ"
 
 target = 'http://localhost:8083'
@@ -207,3 +216,57 @@ def time_series(datasets, bounding_box, start_datetime, end_datetime, spark=Fals
             )
 
     return time_series_result
+
+
+def subset(dataset, bounding_box, start_datetime, end_datetime, parameter, metadata_filter):
+    """
+    Fetches point values for a given dataset and geographical area or metadata criteria and time range.
+
+    __dataset__ Name of the dataset as a String  
+    __bounding_box__ Bounding box for area of interest as a `shapely.geometry.polygon.Polygon`  
+    __start_datetime__ Start time as a `datetime.datetime`  
+    __end_datetime__ End time as a `datetime.datetime`  
+    __parameter__ The parameter of interest. One of 'sst', 'sss', 'wind' or None  
+    __metadata_filter__ List of key:value String metadata criteria  
+
+    __return__ List of `nexuscli.nexuscli.Point` namedtuples
+    """
+    url = "{}/datainbounds?".format(target)
+
+    params = {
+        'ds': dataset,
+        'startTime': start_datetime.strftime(ISO_FORMAT),
+        'endTime': end_datetime.strftime(ISO_FORMAT),
+        'parameter': parameter,
+    }
+    if bounding_box:
+        params['b'] = ','.join(str(b) for b in bounding_box.bounds)
+    else:
+        if metadata_filter and len(metadata_filter) > 0:
+            params['metadataFilter'] = metadata_filter
+
+    response = session.get(url, params=params)
+    response.raise_for_status()
+    response = response.json()
+
+    data = np.array(response['data']).flatten()
+
+    assert len(data) > 0, "No data found in {} between {} and {} for Datasets {}.".format(bounding_box.wkt if bounding_box is not None else metadata_filter,
+                                                                                          start_datetime.strftime(
+                                                                                              ISO_FORMAT),
+                                                                                          end_datetime.strftime(
+                                                                                              ISO_FORMAT),
+                                                                                          dataset)
+
+    subset_result = []
+    for d in data:
+        subset_result.append(
+            Point(
+                time=datetime.utcfromtimestamp(d['time']).replace(tzinfo=UTC),
+                longitude=d['longitude'],
+                latitude=d['latitude'],
+                variable=d['data'][0]
+            )
+        )
+
+    return subset_result
diff --git a/client/nexuscli/test/nexuscli_test.py b/client/nexuscli/test/nexuscli_test.py
index d202a3f..61a7e46 100644
--- a/client/nexuscli/test/nexuscli_test.py
+++ b/client/nexuscli/test/nexuscli_test.py
@@ -39,3 +39,13 @@ def test_daily_difference_average(self):
                                                datetime(2013, 1, 1), datetime(2014, 12, 31))
 
         self.assertEqual(1, len(ts))
+
+    def test_data_in_bounds_with_metadata_filter(self):
+        subset = nexuscli.subset("MUR-JPL-L4-GLOB-v4.1", None, datetime(2018, 1, 1), datetime(2018, 1, 2),
+                                         None, ["id:60758e00-5721-3a6e-bf57-78448bb0aeeb"])
+        print(subset)
+
+    def test_data_in_bounds_with_bounding_box(self):
+        subset = nexuscli.subset("MUR-JPL-L4-GLOB-v4.1", box(-150, 45, -149, 46), datetime(2018, 1, 1),
+                                         datetime(2018, 1, 1), None, None)
+        print(subset)


 

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services