Lint Tidal (#386)

- Enforce PyLint and add type hints

Author: ssolson

.github/workflows/pylint.yml

@@ -36,3 +36,7 @@ jobs:
       - name: Run Pylint on mhkit/acoustics/
         run: |
           pylint mhkit/acoustics/
+
+      - name: Run Pylint on mhkit/tidal
+        run: |
+          pylint mhkit/tidal/

examples/metocean_example.ipynb

@@ -74,13 +74,16 @@ def test_request_noaa_data_basic(self):
         and verify that the returned DataFrame and metadata have the
         correct shape and columns.
         """
+        options = {
+            "proxy": None,
+            "write_json": None,
+        }
         data, metadata = tidal.io.noaa.request_noaa_data(
             station="s08010",
             parameter="currents",
             start_date="20180101",
             end_date="20180102",
-            proxy=None,
-            write_json=None,
+            options=options,
         )
         self.assertTrue(np.all(data.columns == ["s", "d", "b"]))
         self.assertEqual(data.shape, (183, 3))
@@ -92,14 +95,17 @@ def test_request_noaa_data_basic_xarray(self):
         and verify that the returned DataFrame and metadata have the
         correct shape and columns.
         """
+        options = {
+            "proxy": None,
+            "write_json": None,
+            "to_pandas": False,
+        }
         data = tidal.io.noaa.request_noaa_data(
             station="s08010",
             parameter="currents",
             start_date="20180101",
             end_date="20180102",
-            proxy=None,
-            write_json=None,
-            to_pandas=False,
+            options=options,
         )
         # Check if the variable sets are equal
         data_variables = list(data.variables)
@@ -117,13 +123,16 @@ def test_request_noaa_data_write_json(self):
         and can be loaded back into a dictionary.
         """
         test_json_file = "test_noaa_data.json"
+        options = {
+            "proxy": None,
+            "write_json": test_json_file,
+        }
         _, _ = tidal.io.noaa.request_noaa_data(
             station="s08010",
             parameter="currents",
             start_date="20180101",
             end_date="20180102",
-            proxy=None,
-            write_json=test_json_file,
+            options=options,
         )
         self.assertTrue(os.path.isfile(test_json_file))
 
@@ -142,29 +151,35 @@ def test_request_noaa_data_invalid_dates(self):
         Test the request_noaa_data function with an invalid date format
         and verify that it raises a ValueError.
         """
+        options = {
+            "proxy": None,
+            "write_json": None,
+        }
         with self.assertRaises(ValueError):
             tidal.io.noaa.request_noaa_data(
                 station="s08010",
                 parameter="currents",
                 start_date="2018-01-01",  # Invalid date format
                 end_date="20180102",
-                proxy=None,
-                write_json=None,
+                options=options,
             )
 
     def test_request_noaa_data_end_before_start(self):
         """
         Test the request_noaa_data function with the end date before
         the start date and verify that it raises a ValueError.
         """
+        options = {
+            "proxy": None,
+            "write_json": None,
+        }
         with self.assertRaises(ValueError):
             tidal.io.noaa.request_noaa_data(
                 station="s08010",
                 parameter="currents",
                 start_date="20180102",
                 end_date="20180101",  # End date before start date
-                proxy=None,
-                write_json=None,
+                options=options,
             )
 
 

examples/tidal_example.ipynb

@@ -1,3 +1,11 @@
+"""
+MHKiT Tidal Module
+
+The tidal module contains a set of functions to calculate quantities of
+interest for tidal energy converters (TEC). The tidal module uses timeseries
+data of velocity and direction.
+"""
+
 from mhkit.tidal import graphics
 from mhkit.tidal import io
 from mhkit.tidal import resource