Metocean module - WIND Toolkit (#187)

* initial script

* update wind_toolkit with 4 regions and 1-hr or 5-min data

* update parameters of wind_toolkit functions

* compare NDBC and WIND metocean data

* fix typo in wpto hindcast example

* finish metocean example and add results

* add wind_toolkit to wave/io/__init__.py

* update WIND Toolkit parameter list

* initial test structure for WIND toolkit

* finish metocean example

* add function to plot each region

* wind toolkit tests and test data

* add tests for misc wind_toolkit MHKiT functions and cases

* fix wind toolkit tests

* add elevation_to_string utility function

* misc cleanup

* clarify available parameters

* add users lat_lon to plot_region visualization

* update example with new functions

* add numpy dependency back in

* Ingnore the new hindcast folder

* Include only the new hindcast folder

* Move hindcast tests to hindcast folder

* Specify exclusion of hindcast from standard coverage

* update hindcast coverage

* remove unnecessary header

* move hindcast and wind_toolkit to wave/io/hindcast

* update .coveragerc files

* update paths for new wave.io.hindcast directory

Co-authored-by: ssolson <[email protected]>

Author: akeeste

.github/workflows/.coveragehindcastrc

@@ -1,7 +1,10 @@
 [run]
 include =
-    ./mhkit/wave/io/hindcast.py
+    ./mhkit/wave/io/hindcast/hindcast.py
+    ./mhkit/wave/io/hindcast/wind_toolkit.py
 
 [report]
 include =
-    ./mhkit/wave/io/hindcast.py
+    ./mhkit/wave/io/hindcast/hindcast.py
+    ./mhkit/wave/io/hindcast/wind_toolkit.py
+    

.github/workflows/.coveragerc

@@ -1,11 +1,13 @@
 [run]
 omit =
-    # omit everything in tests and /wave
+    # omit everything in tests and hindcast functions
     ./mhkit/tests/*
-    ./mhkit/wave/io/hindcast.py
+    ./mhkit/wave/io/hindcast/hindcast.py
+    ./mhkit/wave/io/hindcast/wind_toolkit.py
 
 [report]
 omit =
-    # omit everything in tests and /wave
+    # omit everything in tests and hindcast functions
     ./mhkit/tests/*    
-    ./mhkit/wave/io/hindcast.py
+    ./mhkit/wave/io/hindcast/hindcast.py
+    ./mhkit/wave/io/hindcast/wind_toolkit.py

.github/workflows/pytest-hindcast.ini

@@ -1,2 +1,2 @@
 [pytest]
-addopts = ./mhkit/tests/wave/io/test_hindcast.py
+addopts = ./mhkit/tests/wave/io/hindcast

.github/workflows/pytest.ini

@@ -1,2 +1,2 @@
 [pytest]
-addopts = --ignore=./mhkit/tests/wave/io/test_hindcast.py
+addopts = --ignore=./mhkit/tests/wave/io/hindcast

examples/WPTO_hindcast_example.ipynb

@@ -102,7 +102,7 @@
    ],
    "source": [
     "lat_lon = [44.624076,-124.280097]\n",
-    "region = wave.io.hindcast.region_selection(lat_lon)\n",
+    "region = wave.io.hindcast.hindcast.region_selection(lat_lon)\n",
     "print(region)"
    ]
   },
@@ -112,7 +112,7 @@
    "source": [
     "### 2. Download WPTO Hindcast Data from a Single Location\n",
     "\n",
-    "In this example we will request 3-hour significant wave height for 1995 at the point (44.624076,-124.280097, near the PacWave site). We will speficy each of these as a variable and pass them to the wave IO hindacast function `request_wpto_dataset`. The data type will be a high-spatial-resolution dataset,  year(s) will be 1995,  latitude/longitude pairs will be for a point near PacWave, and the parameter will be significant wave height."
+    "In this example we will request 3-hour significant wave height for 1995 at the point (44.624076,-124.280097, near the PacWave site). We will speficy each of these as a variable and pass them to the wave IO hindcast function `request_wpto_dataset`. The data type will be a high-spatial-resolution dataset,  year(s) will be 1995,  latitude/longitude pairs will be for a point near PacWave, and the parameter will be significant wave height."
    ]
   },
   {
@@ -126,7 +126,7 @@
     "lat_lon = (44.624076,-124.280097) \n",
     "parameter = 'significant_wave_height' \n",
     "\n",
-    "Hs, metadata= wave.io.hindcast.request_wpto_point_data(data_type,parameter,lat_lon,years)"
+    "Hs, metadata= wave.io.hindcast.hindcast.request_wpto_point_data(data_type,parameter,lat_lon,years)"
    ]
   },
   {
@@ -206,7 +206,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "#### Hindacast Data Returned \n",
+    "#### Hindcast Data Returned \n",
     "\n",
     "We can also take a look at the first 5 rows of the returned data by call the `head()` method on the returned data. By calling this below we can see that the returned data has a time index and a single column of significant wave height. The siginifcant wave height column has a 0 integer on the end of it refering to the index in the metadata. In out next example the importance of this integer will become more clear as we begin to request multiple locations."
    ]
@@ -382,7 +382,7 @@
     "lat_lon = ((44.624076,-124.280097),\n",
     "           (43.489171,-125.152137)) \n",
     "\n",
-    "Te, metadata = wave.io.hindcast.request_wpto_point_data(data_type, parameter, lat_lon, years)\n",
+    "Te, metadata = wave.io.hindcast.hindcast.request_wpto_point_data(data_type, parameter, lat_lon, years)\n",
     "\n",
     "# View Te from two locations\n",
     "Te.head()"
@@ -586,7 +586,7 @@
     "parameter = 'omni-directional_wave_power'\n",
     "lat_lon = (44.624076,-124.280097) \n",
     "\n",
-    "J, metadata= wave.io.hindcast.request_wpto_point_data(data_type,parameter,lat_lon,years) \n",
+    "J, metadata= wave.io.hindcast.hindcast.request_wpto_point_data(data_type,parameter,lat_lon,years) \n",
     "\n",
     "J"
    ]
@@ -675,7 +675,7 @@
     "parameter = ['significant_wave_height','peak_period','mean_wave_direction']\n",
     "lat_lon = (44.624076,-124.280097) \n",
     "\n",
-    "data, metadata= wave.io.hindcast.request_wpto_point_data(data_type,parameter,lat_lon,years) "
+    "data, metadata= wave.io.hindcast.hindcast.request_wpto_point_data(data_type,parameter,lat_lon,years) "
    ]
   },
   {
@@ -1907,7 +1907,7 @@
    "source": [
     "year = '1993'  # only one year can be passed at a time as a string\n",
     "lat_lon=(43.489171,-125.152137)\n",
-    "dir_spectra,meta = wave.io.hindcast.request_wpto_directional_spectrum(lat_lon,year)\n",
+    "dir_spectra,meta = wave.io.hindcast.hindcast.request_wpto_directional_spectrum(lat_lon,year)\n",
     "\n",
     "print(dir_spectra)"
    ]