Merge branch 'develop' of https://github.com/MHKiT-Software/MHKiT-Python into lint-river

Author: ssolson

mhkit/tidal/graphics.py

@@ -5,21 +5,6 @@
 It includes tools for creating polar plots, velocity distributions, exceedance
 probability charts, and current time-series plots.
 
-Features:
----------
-- Generates **polar histograms** (current roses) of tidal flow directions and speeds.
-- Computes and visualizes **joint probability distributions** of velocity and direction.
-- Plots **time-series data** of tidal currents in a given principal direction.
-- Creates **exceedance probability** plots for ebb and flood conditions.
-- Supports **custom metadata annotations** (site name, latitude, longitude).
-
-Functions:
-----------
-- `plot_rose`: Creates a polar histogram of flow directions and velocities.
-- `plot_joint_probability_distribution`: Generates a joint probability distribution.
-- `plot_current_timeseries`: Plots velocity time-series in the principal direction.
-- `tidal_phase_probability`: Analyzes probability of flow in flood or ebb phases.
-- `tidal_phase_exceedance`: Creates a stacked exceedance probability plot.
 """
 
 import bisect
@@ -222,7 +207,9 @@ def plot_rose(
             color=colors[vel_bin],
             label=labels[vel_bin],
         )
-        r_offset += histogram[:, vel_bin]  # Update in place
+        r_offset += histogram[
+            :, vel_bin
+        ]  # Increase the radius offset in all directions
 
     # Configure legend and ticks
     plt.legend(

mhkit/tidal/io/__init__.py

@@ -1,5 +1,5 @@
 """
-This module initializes the tidal I/O package, importing necessary submodules.
+The io submodule contains functions to load NOAA and Delft3D data.
 """
 
 from mhkit.tidal.io import noaa

mhkit/tidal/io/noaa.py

@@ -6,26 +6,6 @@
 Currents API (https://api.tidesandcurrents.noaa.gov/api/prod/). It supports
 retrieving data in XML and JSON formats, converting it into a pandas DataFrame
 or xarray Dataset, and saving it as a JSON file for future use.
-
-Features:
----------
-- Fetch NOAA current, tidal, and environmental data from the API.
-- Convert XML and JSON responses into structured pandas DataFrames.
-- Cache and retrieve previously requested data to optimize performance.
-- Save and load data from JSON files for offline access.
-
-Functions:
-----------
-request_noaa_data(station, parameter, start_date, end_date, options=None):
-    Fetches NOAA data from the API, converts it into a pandas DataFrame (or xarray Dataset),
-    and caches the result. Supports proxy settings and JSON file export.
-
-_xml_to_dataframe(response):
-    Converts NOAA response data from XML format into a pandas DataFrame and extracts metadata.
-
-read_noaa_json(filename, to_pandas=True):
-    Reads a previously saved JSON file containing NOAA data and returns a pandas DataFrame
-    (or xarray Dataset) with time-series data and metadata.
 """
 
 import os

mhkit/tidal/performance.py

@@ -6,30 +6,6 @@
 methods for calculating power curves, efficiency, velocity profiles, and
 other metrics relevant to marine energy devices.
 
-Features:
----------
-- Computes **power curves** and performance statistics for marine energy devices.
-- Evaluates **device efficiency** based on IEC/TS 62600-200 standards.
-- Analyzes **velocity profiles** using time-averaging and statistical functions.
-- Supports **circular and rectangular turbine profiles** for swept area calculations.
-- Processes **ADCP data** to derive meaningful hydrodynamic insights.
-
-Functions:
-----------
-- `_slice_circular_capture_area`: Slices a circular capture area based on ADCP depth bins.
-- `_slice_rectangular_capture_area`: Slices a rectangular capture area based on ADCP depth bins.
-- `power_curve`: Computes power curve and power statistics for a marine energy device.
-- `_average_velocity_bins`: Averages velocity profiles into velocity bins.
-- `_apply_function`: Applies statistical functions (mean, RMS, std) to velocity data.
-- `velocity_profiles`: Computes velocity profiles for different statistical measures.
-- `device_efficiency`: Computes the efficiency (power coefficient) of a tidal energy device.
-- `_calculate_density`: Computes averaged water density for a given time period.
-
-Usage:
-------
-This module is intended for use with ADCP data to evaluate the performance
-of marine energy devices based on IEC/TS 62600-200 standards. It is useful for
-hydrodynamic modeling, resource assessment, and marine energy system optimization.
 """
 
 from typing import Union, Optional

mhkit/tidal/resource.py

@@ -4,38 +4,16 @@
 principal flow directions, classifying ebb and flood cycles, and
 computing probability distributions of flow velocities.
 
-Features:
----------
-- Computes joint probability histograms of flow directions and velocities.
-- Determines principal flow directions using histogram-based analysis.
-- Classifies ebb and flood conditions based on directional data.
-- Normalizes flow angles for consistent analysis.
-
-Functions:
-----------
-- `_histogram(directions, velocities, width_dir, width_vel)`:
-  Computes a joint probability histogram of flow directions and velocities.
-
-- `_normalize_angle(degree)`:
-  Normalizes an angle to the range [0, 360] degrees.
-
-- `principal_flow_directions(directions, width_dir)`:
-  Determines principal flow directions for ebb and flood cycles
-  using a histogram-based approach.
-
-- `_flood_or_ebb(d, flood, ebb)`:
-  Identifies whether a given set of flow directions corresponds to
-  ebb or flood conditions.
 """
 
 import math
 import numpy as np
-from mhkit.river.resource import exceedance_probability, froude_number
+from mhkit.river.resource import exceedance_probability, Froude_number
 from mhkit.utils import convert_to_dataarray
 
 __all__ = [
     "exceedance_probability",
-    "froude_number",
+    "Froude_number",
     "principal_flow_directions",
     "_histogram",
     "_flood_or_ebb",