Add unit tests for gpm_api.io

gpm_api/io/checks.py

@@ -1,4 +1,4 @@
 #!/usr/bin/env python3
 """
 Created on Sun Aug 14 20:02:18 2022
 @author: ghiggi
@@ -32,7 +32,7 @@
         Base directory where the GPM directory is located.
     """
     # Check base_dir does not end with /
-    if base_dir[-1] == "/":
+    if base_dir[-1] == os.path.sep:
         base_dir = base_dir[0:-1]
     # Retrieve last folder name
     dir_name = os.path.basename(base_dir)
@@ -157,15 +157,15 @@
     if isinstance(time, np.ndarray):
         if np.issubdtype(time.dtype, np.datetime64):
             if time.size == 1:
-                time = time.astype("datetime64[s]").tolist()
+                time = time.astype("datetime64[us]").tolist()
             else:
                 raise ValueError("Expecting a single timestep!")
         else:
             raise ValueError("The numpy array does not have a np.datetime64 dtype!")
 
-    # If np.datetime64, convert to datetime.datetime
+    # If np.datetime64, convert to datetime.datetime with microsecond precision
     if isinstance(time, np.datetime64):
-        time = time.astype("datetime64[s]").tolist()
+        time = time.astype("datetime64[us]").tolist()
     # If datetime.date, convert to datetime.datetime
     if not isinstance(time, (datetime.datetime, str)):
         time = datetime.datetime(time.year, time.month, time.day, 0, 0, 0)
@@ -178,11 +178,12 @@
 
 
 def check_date(date):
-    if not isinstance(date, (datetime.date, datetime.datetime)):
-        raise ValueError("date must be a datetime object")
-    if isinstance(date, datetime.datetime):
-        date = date.date()
-    return date
+    if date is None:
+        raise ValueError("date cannot be None")
+
+    # Use check_time to convert to datetime.datetime
+    datetime_obj = check_time(date)
+    return datetime_obj.date()
 
 
 def check_start_end_time(start_time, end_time):
@@ -224,26 +225,4 @@
         raise ValueError(f"For {product} product, valid scan_modes are {scan_modes}.")
 
     # -------------------------------------------------------------------------.
     return scan_mode
-
-
-def check_bbox(bbox):
-    """
-    Check correctness of bounding box.
-    bbox format: [lon_0, lon_1, lat_0, lat_1]
-    bbox should be provided with longitude between -180 and 180, and latitude
-    between -90 and 90.
-    """
-    if bbox is None:
-        return bbox
-    # If bbox provided
-    if not (isinstance(bbox, list) and len(bbox) == 4):
-        raise ValueError("Provide valid bbox [lon_0, lon_1, lat_0, lat_1]")
-    if bbox[2] > 90 or bbox[2] < -90 or bbox[3] > 90 or bbox[3] < -90:
-        raise ValueError("Latitude is defined between -90 and 90")
-    # Try to be sure that longitude is specified between -180 and 180
-    if bbox[0] > 180 or bbox[1] > 180:
-        print("bbox should be provided with longitude between -180 and 180")
-        bbox[0] = bbox[0] - 180
-        bbox[1] = bbox[1] - 180
-    return bbox

gpm_api/io/directories.py

@@ -44,8 +44,6 @@ def get_disk_dir_pattern(product, product_type, version):
         GPM product name. See: gpm_api.available_products()
     product_type : str, optional
         GPM product type. Either 'RS' (Research) or 'NRT' (Near-Real-Time).
-    date : datetime.date
-        Single date for which to retrieve the data.
     version : int, optional
         GPM version of the data to retrieve if product_type = 'RS'.
 

gpm_api/io/download.py

@@ -71,7 +71,7 @@
     # -------------------------------------------------------------------------.
     # Replace ftps with ftp to make curl work !!!
     # - curl expects ftp:// and not ftps://
-    server_path = server_path.replace("ftps", "ftp", 1)
+    server_path = server_path.replace("ftps://", "ftp://", 1)
     # -------------------------------------------------------------------------.
     ## Define command to run
     # Base command: curl -4 --ftp-ssl --user [user name]:[password] -n [url]
@@ -195,7 +195,7 @@
 
     pbar is a tqdm progress bar.
     """
     # TODO: maybe here capture (with -1) if the file does not exists !¨
     n_futures = len(dict_futures)
     status = [1] * n_futures
     for future in as_completed(dict_futures.keys()):
@@ -258,7 +258,6 @@
     progress_bar=True,
     verbose=False,
 ):
-
     if transfer_tool == "curl":
         list_cmd = [
             curl_cmd(src_path, dst_path, username, username)

gpm_api/io/filter.py

@@ -234,11 +234,10 @@ def filter_by_time(filepaths, start_time=None, end_time=None):
     ----------
     filepaths : list
         List of filepaths.
-
     start_time : datetime.datetime
-        Start time
+        Start time. Will be set to GPM start mission time (1998-01-01) if None.
     end_time : datetime.datetime
-        End time.
+        End time. Will be set to current time (`datetime.datetime.utcnow()`) if None.
 
     Returns
     ----------
@@ -260,7 +259,7 @@ def filter_by_time(filepaths, start_time=None, end_time=None):
     if start_time is None:
         start_time = datetime.datetime(1998, 1, 1, 0, 0, 0)  # GPM start mission
     if end_time is None:
-        end_time = datetime.datetime.now()  # Current time
+        end_time = datetime.datetime.utcnow()  # Current time
     start_time, end_time = check_start_end_time(start_time, end_time)
 
     # -------------------------------------------------------------------------.