wave-shoaling-physics 0.1.3__tar.gz

wave_shoaling_physics-0.1.3/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Tu Nombre
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

wave_shoaling_physics-0.1.3/PKG-INFO

@@ -0,0 +1,26 @@
+Metadata-Version: 2.4
+Name: wave-shoaling-physics
+Version: 0.1.3
+Summary: Gravity wave mechanics: dispersion, shoaling and coastal breaking with real-time marine data
+Author-email: Adrian Hernandez <adrian.hernandezv@alumni.mondragon.edu>
+License: MIT
+Keywords: physics,waves,shoaling,oceanography
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests>=2.28.0
+Requires-Dist: numpy>=1.22.0
+Dynamic: license-file
+
+# Wave Shoaling Physics  
+Library for modeling the propagation and shoaling of ocean waves. Requires entering coordinates explicitly to analyze any point on the planet. 
+
+## Usage example 
+```python 
+from wave_shoaling import fetch_marine_data, calculate_shoaling 
+
+# The user MUST provide the exact coordinates (no default values) 
+mar = fetch_marine_data(latitude=39.60, longitude=-9.07) # Ex: Nazaré, Portugal

wave_shoaling_physics-0.1.3/README.md

@@ -0,0 +1,9 @@
+# Wave Shoaling Physics  
+Library for modeling the propagation and shoaling of ocean waves. Requires entering coordinates explicitly to analyze any point on the planet. 
+
+## Usage example 
+```python 
+from wave_shoaling import fetch_marine_data, calculate_shoaling 
+
+# The user MUST provide the exact coordinates (no default values) 
+mar = fetch_marine_data(latitude=39.60, longitude=-9.07) # Ex: Nazaré, Portugal

wave_shoaling_physics-0.1.3/pyproject.toml

@@ -0,0 +1,24 @@
+[build-system] 
+requires = ["setuptools>=61.0"] 
+build-backend = "setuptools.build_meta" 
+
+[project] 
+name = "wave-shoaling-physics" 
+version = "0.1.3" 
+authors = [     
+    {name = "Adrian Hernandez", email = "adrian.hernandezv@alumni.mondragon.edu"}
+] 
+description = "Gravity wave mechanics: dispersion, shoaling and coastal breaking with real-time marine data" 
+readme = "README.md" 
+requires-python = ">=3.9" 
+license = {text = "MIT"} 
+keywords = ["physics", "waves", "shoaling", "oceanography"] 
+dependencies = [     
+    "requests>=2.28.0",     
+    "numpy>=1.22.0",
+]
+classifiers = [     
+    "Programming Language :: Python :: 3",     
+    "License :: OSI Approved :: MIT License",     
+    "Operating System :: OS Independent",
+]

wave_shoaling_physics-0.1.3/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

wave_shoaling_physics-0.1.3/tests/test_core.py

@@ -0,0 +1,22 @@
+import numpy as np
+from wave_shoaling.core import solve_dispersion, calculate_shoaling
+
+def test_dispersion_deep_water():
+    omega = 1.0
+    depth = 500.0
+    k = solve_dispersion(omega, depth)
+    expected_k = (omega ** 2) / 9.80665
+    assert np.isclose(k, expected_k, rel_tol=1e-3)
+
+def test_calculate_shoaling_physics():
+    res = calculate_shoaling(hs_deep=2.0, tp=10.0, depth_coastal=5.0)
+    assert res["power_kw_per_meter"] > 0
+    assert isinstance(res["is_breaking"], bool)
+
+def test_invalid_depth():
+    try:
+        solve_dispersion(omega=1.0, depth=-10.0)
+    except ValueError:
+        pass
+    else:
+        raise AssertionError("Value Error")

wave_shoaling_physics-0.1.3/wave_shoaling/__init__.py

@@ -0,0 +1,5 @@
+"""wave-shoaling-physics: Transformation and breaking of ocean waves on the coast.""" 
+from .core import solve_dispersion, calculate_shoaling, fetch_marine_data 
+
+__all__ = ["solve_dispersion", "calculate_shoaling", "fetch_marine_data"] 
+__version__ = "0.1.2"

wave_shoaling_physics-0.1.3/wave_shoaling/core.py

@@ -0,0 +1,59 @@
+from typing import Dict, Any 
+import numpy as np 
+import requests 
+
+G = 9.80665 
+RHO_SEAWATER = 1025.0 
+
+def solve_dispersion(omega: float, depth: float, tol: float = 1e-6, max_iter: int = 100) -> float:     
+    if depth <= 0:         
+        raise ValueError("Depth must be a positive value.")     
+    k = (omega ** 2) / G     
+    for _ in range(max_iter):         
+        th = np.tanh(k * depth)         
+        f = (omega ** 2) - G * k * th         
+        df = -G * th - G * k * depth * (1.0 - th ** 2)         
+        k_next = k - f / df         
+        if abs(k_next - k) < tol:             
+            return float(k_next)         
+        k = k_next     
+    return float(k) 
+
+def calculate_shoaling(hs_deep: float, tp: float, depth_coastal: float) -> Dict[str, float]:     
+    omega = 2.0 * np.pi / tp     
+    k_deep = (omega ** 2) / G     
+    cg_deep = 0.5 * (omega / k_deep)          
+    k_coastal = solve_dispersion(omega, depth_coastal)     
+    wavelength_coastal = (2.0 * np.pi) / k_coastal          
+    kh = k_coastal * depth_coastal     
+    phase_velocity = omega / k_coastal     
+    cg_coastal = phase_velocity * 0.5 * (1.0 + (2.0 * kh) / np.sinh(2.0 * kh))     
+    ks = np.sqrt(cg_deep / cg_coastal)     
+    hs_coastal = hs_deep * ks     
+    energy_density = (1.0 / 8.0) * RHO_SEAWATER * G * (hs_coastal ** 2)     
+    power_kw_m = (energy_density * cg_coastal) / 1000.0     
+    h_max_miche = 0.142 * wavelength_coastal * np.tanh(kh)     
+    breaks = bool(hs_coastal >= h_max_miche)     
+    
+    return {         
+        "wavelength_coastal_m": round(float(wavelength_coastal), 2),         
+        "shoaling_coefficient": round(float(ks), 3),         
+        "hs_coastal_m": round(float(hs_coastal), 2),         
+        "power_kw_per_meter": round(float(power_kw_m), 2),         
+        "miche_breaking_limit_m": round(float(h_max_miche), 2),         
+        "is_breaking": breaks,     
+    } 
+
+def fetch_marine_data(latitude: float, longitude: float) -> Dict[str, Any]:     
+    """Downloads data forcing the user to explicitly input latitude and longitude."""     
+    url = f"https://marine-api.open-meteo.com/v1/marine?latitude={latitude}&longitude={longitude}&current=wave_height,wave_period,wave_direction"     
+    res = requests.get(url, timeout=10)     
+    res.raise_for_status()     
+    current = res.json().get("current", {})     
+    return {         
+        "latitude": latitude,         
+        "longitude": longitude,         
+        "wave_height_m": current.get("wave_height", 1.5),         
+        "wave_period_s": current.get("wave_period", 10.0),         
+        "wave_direction_deg": current.get("wave_direction", 315.0),     
+    }

wave_shoaling_physics-0.1.3/wave_shoaling_physics.egg-info/PKG-INFO

@@ -0,0 +1,26 @@
+Metadata-Version: 2.4
+Name: wave-shoaling-physics
+Version: 0.1.3
+Summary: Gravity wave mechanics: dispersion, shoaling and coastal breaking with real-time marine data
+Author-email: Adrian Hernandez <adrian.hernandezv@alumni.mondragon.edu>
+License: MIT
+Keywords: physics,waves,shoaling,oceanography
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests>=2.28.0
+Requires-Dist: numpy>=1.22.0
+Dynamic: license-file
+
+# Wave Shoaling Physics  
+Library for modeling the propagation and shoaling of ocean waves. Requires entering coordinates explicitly to analyze any point on the planet. 
+
+## Usage example 
+```python 
+from wave_shoaling import fetch_marine_data, calculate_shoaling 
+
+# The user MUST provide the exact coordinates (no default values) 
+mar = fetch_marine_data(latitude=39.60, longitude=-9.07) # Ex: Nazaré, Portugal

wave_shoaling_physics-0.1.3/wave_shoaling_physics.egg-info/SOURCES.txt

@@ -0,0 +1,11 @@
+LICENSE
+README.md
+pyproject.toml
+tests/test_core.py
+wave_shoaling/__init__.py
+wave_shoaling/core.py
+wave_shoaling_physics.egg-info/PKG-INFO
+wave_shoaling_physics.egg-info/SOURCES.txt
+wave_shoaling_physics.egg-info/dependency_links.txt
+wave_shoaling_physics.egg-info/requires.txt
+wave_shoaling_physics.egg-info/top_level.txt

wave_shoaling_physics-0.1.3/wave_shoaling_physics.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

wave_shoaling_physics-0.1.3/wave_shoaling_physics.egg-info/requires.txt

@@ -0,0 +1,2 @@
+requests>=2.28.0
+numpy>=1.22.0

wave_shoaling_physics-0.1.3/wave_shoaling_physics.egg-info/top_level.txt

@@ -0,0 +1 @@
+wave_shoaling