Merge pull request #160 from Ocean-Data-Lab/final-changes-into-116

Incorporate changes from Don's review of PR#150

Author: John-Ragland

CITATION.cff

@@ -13,6 +13,8 @@ authors:
   given-names: "Dmitry"
 - family-names: "Abadi"
   given-names: "Shima"
+- family-names: "Dixit"
+  given-names: "Anish"
 title: "OOIPy: A Python toolbox designed to aid in the scientific analysis of Ocean Observatories Initiative (OOI) data"
 version: 1.1.3
 doi: 10.5281/zenodo.5165389

docs/source/install_instructions.rst

@@ -12,7 +12,7 @@ OOIPY is available on PyPI.
 
 Install Instruction
 -------------------
-OOIPY is designed to run on Python > 3.7 To install OOIPY, run the following command.
+OOIPY is designed to run on Python version 3.9 and above. To install OOIPY, run the following command:
 
 .. code-block :: bash
 
@@ -34,7 +34,7 @@ How to setup OOIPY development environment
 
 .. code-block :: bash
 
-  conda create --name env_name pip
+  conda create --name env_name python=3.10 pip
 
 3. Activate the environment using this command:
 

ooipy/hydrophone/basic.py

@@ -146,8 +146,8 @@ def compute_spectrogram(
 
         Returns
         -------
-        Spectrogram
-            An Xarray.DataArray object that contains time and frequency bins as
+        spectrogram : xr.DataArray
+            An ``xarray.DataArray`` object that contains time and frequency bins as
             well as corresponding values. If no noise date is available,
             None is returned.
         """
@@ -305,8 +305,8 @@ def compute_spectrogram_mp(
 
         Returns
         -------
-        Spectrogram
-            An Xarray.DataArray object that contains time and frequency bins as well
+        spectrogram : xr.DataArray
+            An ``xarray.DataArray`` object that contains time and frequency bins as well
             as corresponding values. If no noise date is available,
             None is returned.
         """
@@ -414,8 +414,8 @@ def compute_psd_welch(
 
         Returns
         -------
-        Psd
-            An xarray.DataArray object that contains frequency bins and PSD values. If no
+        psd : xr.DataArray
+           An ``xarray.DataArray`` object that contains frequency bins and PSD values. If no
             noise date is available, None is returned.
         """
         # get noise data segment for each entry in rain_event
@@ -589,7 +589,7 @@ def get_asset_ID(self):
 
         return asset_ID
 
-    def save(self, file_format, filename, wav_kwargs={}):
+    def save(self, file_format, filename, wav_kwargs={}) -> None:
         """
         save hydrophone data in specified method. Supported methods are:
         - pickle - saves the HydrophoneData object as a pickle file

ooipy/request/hydrophone_request.py

@@ -517,8 +517,10 @@ def __map_concurrency(func, iterator, args=(), max_workers=-1, verbose=False):
     with concurrent.futures.ThreadPoolExecutor(max_workers=max_workers) as executor:
         # Start the load operations and mark each future with its URL
         future_to_url = {executor.submit(func, i, *args): i for i in iterator}
+        # Disable progress bar
+        is_disabled = not verbose
         for future in tqdm(
-            concurrent.futures.as_completed(future_to_url), total=len(iterator), disable=not verbose
+            concurrent.futures.as_completed(future_to_url), total=len(iterator), disable=is_disabled
         ):
             data = future.result()
             results.append(data)