MHKiT-Python icon indicating copy to clipboard operation
MHKiT-Python copied to clipboard

v0.8.0 bug fixes and doc string fixes

Open akeeste opened this issue 9 months ago • 15 comments

This PR addresses several bug and doc string fixes in v0.8.0. I think it's critical that we make these fixes before our workshop next Thursday.

I tested all of our Python examples on a clean install of MHKiT with Python 3.11. There are several examples with errors

  • [ ] ADCP_Delft3D_TRTS_example.ipynb - Scipy interpolation error
  • [ ] cdip_example.ipynb - Error indexing by YYYY-MM. Passes in 3.9 but not 3.11
  • [ ] directional_waves.ipynb - Error reading cached data. Passes in 3.9 but not 3.11
  • [ ] metocean_example.ipynb - Pandas date indexing error. Passes in 3.9 but not 3.11
  • [ ] PacWave_resource_characterization_example.ipynb - Folium map error
  • [x] qc_example.ipynb - mhkit.utils.index_to_datetime is removed/renamed
  • [x] tidal_example.ipynb - Error slicing by time. Passes in 3.9 but not 3.11
  • [x] wave_example.ipynb - Warning about pd.csv_read infering a date format. Error defining the "mean" statistic
  • [x] WPTO_hindcast_example.ipynb - error getting the variable significant_wave_height_0

Incorporates several minor documentation fixes:

  • [x] updates links in NOAA functions
  • [x] fixes formatting in the mooring example
  • [ ] mitigate warnings due to doc string issues, spacing, etc

akeeste avatar May 14 '24 21:05 akeeste