bathy 0.2.0__tar.gz

bathy-0.2.0/LICENSE

@@ -0,0 +1,15 @@
+MIT License
+
+Copyright (c) 2025 Euan Soutter
+
+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.

bathy-0.2.0/PKG-INFO

@@ -0,0 +1,188 @@
+Metadata-Version: 2.3
+Name: bathy
+Version: 0.2.0
+Summary: Lightweight Python package for exploring bathymetry data.
+Keywords: bathymetry,geomorphology,oceanography
+Author: eslrgs
+Author-email: eslrgs <euan-soutter@hotmail.co.uk>
+License: MIT License
+         
+         Copyright (c) 2025 Euan Soutter
+         
+         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.
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering
+Requires-Dist: xarray>=2024.1.0
+Requires-Dist: netcdf4>=1.6.0
+Requires-Dist: numpy>=1.24.0
+Requires-Dist: matplotlib>=3.8.0
+Requires-Dist: scipy>=1.11.0
+Requires-Dist: geographiclib>=2.0
+Requires-Dist: geopandas>=0.14.0
+Requires-Dist: pydap>=3.5.8
+Requires-Dist: cmocean>=4.0.0
+Requires-Dist: rioxarray>=0.15.0
+Requires-Dist: polars>=1.0.0
+Requires-Dist: tqdm>=4.66.0
+Requires-Dist: pooch>=1.7.0
+Requires-Dist: owslib>=0.31.0
+Requires-Dist: folium>=0.17.0
+Requires-Dist: pyqt6>=6.5.0 ; extra == 'draw'
+Requires-Dist: jupyter>=1.0.0 ; extra == 'notebook'
+Requires-Dist: ipykernel>=6.0.0 ; extra == 'notebook'
+Requires-Python: >=3.12
+Project-URL: Homepage, https://github.com/eslrgs/bathy
+Project-URL: Repository, https://github.com/eslrgs/bathy
+Project-URL: Documentation, https://eslrgs.github.io/bathy/
+Project-URL: Issues, https://github.com/eslrgs/bathy/issues
+Provides-Extra: draw
+Provides-Extra: notebook
+Description-Content-Type: text/markdown
+
+# 🌐 bathy
+
+![Status](https://img.shields.io/badge/status-experimental-red)
+[![CI](https://github.com/eslrgs/bathy/actions/workflows/ci.yml/badge.svg)](https://github.com/eslrgs/bathy/actions/workflows/ci.yml)
+[![Docs](https://img.shields.io/badge/docs-GitHub%20Pages-blue)](https://eslrgs.github.io/bathy)
+![Python](https://img.shields.io/badge/python-3.12+-yellow)
+[![License: MIT](https://img.shields.io/badge/license-MIT-green)](LICENSE)
+
+`bathy` — from Greek *βαθύς* (bathýs), "deep" — bathymetric analysis and visualisation in Python.
+
+**[Documentation](https://eslrgs.github.io/bathy)** · [Installation](#installation) · [Features](#features) · [Examples](#examples)
+
+## Motivation
+
+I found creating bathymetric plots and profiles in Python surprisingly difficult. `bathy` provides a simple, high-level interface for loading, analysing, and visualising bathymetry data, so you can go from raw grid to reproducible quantitative analysis to finished figure with minimal effort.
+
+## Basic usage
+
+### Load data
+
+```python
+import bathy
+
+# Load from file
+data = bathy.load_bathymetry("GEBCO_2025.nc", lon_range=(-10, 0), lat_range=(50, 60))
+
+# Or download GEBCO data via OPeNDAP
+data = bathy.load_gebco_opendap(lon_range=(-10, 0), lat_range=(50, 60))
+```
+
+### Visualise
+
+```python
+bathy.plot_bathy(data)
+```
+
+<p align="center">
+  <img src="docs/assets/images/plot_bathy.png" width="600" alt="Bathymetry">
+</p>
+
+### Analysis overview
+
+```python
+bathy.plot_overview(data)
+```
+
+<p align="center">
+  <img src="docs/assets/images/plot_overview.png" width="600" alt="Overview">
+</p>
+
+### Profiles and canyon analysis
+
+```python
+prof = bathy.extract_profile(data, (-11.3, 48.7), (-7.3, 47.2), name="Along-slope")
+bathy.plot_profile(prof, show_map=True, bathymetry_data=data)
+```
+
+<p align="center">
+  <img src="docs/assets/images/plot_profile.png" width="600" alt="Profile">
+</p>
+
+```python
+canyons = bathy.get_canyons(prof, prominence=100)
+bathy.plot_canyons(prof, canyons)
+```
+
+<p align="center">
+  <img src="docs/assets/images/plot_canyons.png" width="600" alt="Canyons">
+</p>
+
+## Installation
+
+```bash
+pip install bathy
+```
+
+Or with uv:
+
+```bash
+uv add bathy
+```
+
+## Features
+
+| Category | Description |
+|---|---|
+| **IO** | Load from local files (NetCDF, GeoTIFF), GEBCO OPeNDAP, or EMODnet WCS. Export to GeoTIFF. 28 preset regions included. |
+| **Analysis** | Slope, aspect, curvature, rugosity, BPI, geomorphons, contours, smoothing, hypsometric analysis |
+| **Plotting** | Publication-ready bathymetry, hillshade, slope, aspect, overview, 3D surface, depth zones, histograms, interactive maps |
+| **Profiles** | Extract profiles between points, generate cross-sections, load from file or GeoDataFrame |
+| **Profile analysis** | Statistics, gradient, concavity, knickpoints, canyon detection, comparison across profiles |
+| **Draw** | Interactive PyQt6 desktop tool for drawing and editing profiles with drag, undo, and waypoint editing |
+
+See the [full API reference](https://eslrgs.github.io/bathy) for details.
+
+## Examples
+
+See [examples/basic_usage.ipynb](examples/basic_usage.ipynb), [examples/profiles.ipynb](examples/profiles.ipynb), and [examples/draw_profile.py](examples/draw_profile.py).
+
+### Profile drawing
+
+Draw profiles interactively in a PyQt6 desktop window. Requires `uv pip install bathy[draw]`.
+
+```bash
+uv run bathy-draw path/to/data.nc
+```
+
+- Left-click to add waypoints, right-click to finish a profile, double-click to stop
+- Drag waypoints to reposition, press **z** to undo, shift-click to delete
+- Save/load profiles as GeoPackage, toggle visibility per profile
+
+## Development
+
+```bash
+git clone https://github.com/eslrgs/bathy.git
+cd bathy
+uv sync
+pre-commit install
+```
+
+```bash
+just format  # Format and lint
+just test    # Run tests
+```
+
+## Use of AI
+
+This project was developed with assistance from AI, which was used for code generation, documentation, and testing.
+
+## License
+
+MIT License - see [LICENSE](LICENSE) for details.

bathy-0.2.0/README.md

@@ -0,0 +1,132 @@
+# 🌐 bathy
+
+![Status](https://img.shields.io/badge/status-experimental-red)
+[![CI](https://github.com/eslrgs/bathy/actions/workflows/ci.yml/badge.svg)](https://github.com/eslrgs/bathy/actions/workflows/ci.yml)
+[![Docs](https://img.shields.io/badge/docs-GitHub%20Pages-blue)](https://eslrgs.github.io/bathy)
+![Python](https://img.shields.io/badge/python-3.12+-yellow)
+[![License: MIT](https://img.shields.io/badge/license-MIT-green)](LICENSE)
+
+`bathy` — from Greek *βαθύς* (bathýs), "deep" — bathymetric analysis and visualisation in Python.
+
+**[Documentation](https://eslrgs.github.io/bathy)** · [Installation](#installation) · [Features](#features) · [Examples](#examples)
+
+## Motivation
+
+I found creating bathymetric plots and profiles in Python surprisingly difficult. `bathy` provides a simple, high-level interface for loading, analysing, and visualising bathymetry data, so you can go from raw grid to reproducible quantitative analysis to finished figure with minimal effort.
+
+## Basic usage
+
+### Load data
+
+```python
+import bathy
+
+# Load from file
+data = bathy.load_bathymetry("GEBCO_2025.nc", lon_range=(-10, 0), lat_range=(50, 60))
+
+# Or download GEBCO data via OPeNDAP
+data = bathy.load_gebco_opendap(lon_range=(-10, 0), lat_range=(50, 60))
+```
+
+### Visualise
+
+```python
+bathy.plot_bathy(data)
+```
+
+<p align="center">
+  <img src="docs/assets/images/plot_bathy.png" width="600" alt="Bathymetry">
+</p>
+
+### Analysis overview
+
+```python
+bathy.plot_overview(data)
+```
+
+<p align="center">
+  <img src="docs/assets/images/plot_overview.png" width="600" alt="Overview">
+</p>
+
+### Profiles and canyon analysis
+
+```python
+prof = bathy.extract_profile(data, (-11.3, 48.7), (-7.3, 47.2), name="Along-slope")
+bathy.plot_profile(prof, show_map=True, bathymetry_data=data)
+```
+
+<p align="center">
+  <img src="docs/assets/images/plot_profile.png" width="600" alt="Profile">
+</p>
+
+```python
+canyons = bathy.get_canyons(prof, prominence=100)
+bathy.plot_canyons(prof, canyons)
+```
+
+<p align="center">
+  <img src="docs/assets/images/plot_canyons.png" width="600" alt="Canyons">
+</p>
+
+## Installation
+
+```bash
+pip install bathy
+```
+
+Or with uv:
+
+```bash
+uv add bathy
+```
+
+## Features
+
+| Category | Description |
+|---|---|
+| **IO** | Load from local files (NetCDF, GeoTIFF), GEBCO OPeNDAP, or EMODnet WCS. Export to GeoTIFF. 28 preset regions included. |
+| **Analysis** | Slope, aspect, curvature, rugosity, BPI, geomorphons, contours, smoothing, hypsometric analysis |
+| **Plotting** | Publication-ready bathymetry, hillshade, slope, aspect, overview, 3D surface, depth zones, histograms, interactive maps |
+| **Profiles** | Extract profiles between points, generate cross-sections, load from file or GeoDataFrame |
+| **Profile analysis** | Statistics, gradient, concavity, knickpoints, canyon detection, comparison across profiles |
+| **Draw** | Interactive PyQt6 desktop tool for drawing and editing profiles with drag, undo, and waypoint editing |
+
+See the [full API reference](https://eslrgs.github.io/bathy) for details.
+
+## Examples
+
+See [examples/basic_usage.ipynb](examples/basic_usage.ipynb), [examples/profiles.ipynb](examples/profiles.ipynb), and [examples/draw_profile.py](examples/draw_profile.py).
+
+### Profile drawing
+
+Draw profiles interactively in a PyQt6 desktop window. Requires `uv pip install bathy[draw]`.
+
+```bash
+uv run bathy-draw path/to/data.nc
+```
+
+- Left-click to add waypoints, right-click to finish a profile, double-click to stop
+- Drag waypoints to reposition, press **z** to undo, shift-click to delete
+- Save/load profiles as GeoPackage, toggle visibility per profile
+
+## Development
+
+```bash
+git clone https://github.com/eslrgs/bathy.git
+cd bathy
+uv sync
+pre-commit install
+```
+
+```bash
+just format  # Format and lint
+just test    # Run tests
+```
+
+## Use of AI
+
+This project was developed with assistance from AI, which was used for code generation, documentation, and testing.
+
+## License
+
+MIT License - see [LICENSE](LICENSE) for details.

bathy-0.2.0/pyproject.toml

@@ -0,0 +1,90 @@
+[project]
+name = "bathy"
+version = "0.2.0"
+description = "Lightweight Python package for exploring bathymetry data."
+readme = "README.md"
+authors = [
+    { name = "eslrgs", email = "euan-soutter@hotmail.co.uk" }
+]
+requires-python = ">=3.12"
+license = { file = "LICENSE" }
+keywords = ["bathymetry", "geomorphology", "oceanography"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Science/Research",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Scientific/Engineering",
+]
+
+dependencies = [
+    "xarray>=2024.1.0",
+    "netcdf4>=1.6.0",
+    "numpy>=1.24.0",
+    "matplotlib>=3.8.0",
+    "scipy>=1.11.0",
+    "geographiclib>=2.0",
+    "geopandas>=0.14.0",
+    "pydap>=3.5.8",
+    "cmocean>=4.0.0",
+    "rioxarray>=0.15.0",
+    "polars>=1.0.0",
+    "tqdm>=4.66.0",
+    "pooch>=1.7.0",
+    "owslib>=0.31.0",
+    "folium>=0.17.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/eslrgs/bathy"
+Repository = "https://github.com/eslrgs/bathy"
+Documentation = "https://eslrgs.github.io/bathy/"
+Issues = "https://github.com/eslrgs/bathy/issues"
+
+[project.scripts]
+bathy-draw = "bathy.__main__:main"
+
+[project.optional-dependencies]
+draw = ["PyQt6>=6.5.0"]
+notebook = [
+    "jupyter>=1.0.0",
+    "ipykernel>=6.0.0",
+]
+
+[dependency-groups]
+dev = [
+    "pre-commit>=4.5.0",
+    "ruff>=0.14.8",
+    "pytest>=8.0.0",
+    "mkdocs>=1.6.1",
+    "mkdocs-material>=9.7.1",
+    "mkdocstrings[python]>=1.0.3",
+    "mkdocs-jupyter>=0.25.0",
+    "pytest-cov>=7.0.0",
+]
+
+[build-system]
+requires = ["uv_build>=0.9.18,<0.10.0"]
+build-backend = "uv_build"
+
+[tool.uv.build-backend]
+source-exclude = ["tests/", "examples/", "docs/", "data/", "site/", "**/.DS_Store"]
+wheel-exclude = ["**/.DS_Store"]
+
+[tool.ty.environment]
+extra-paths = ["typings"]
+
+[tool.pytest.ini_options]
+filterwarnings = [
+    "ignore:numpy.ndarray size changed:RuntimeWarning",
+]
+
+[tool.ruff]
+line-length = 88
+target-version = "py312"
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "N", "W"]
+ignore = []

bathy-0.2.0/src/bathy/__init__.py

@@ -0,0 +1,145 @@
+"""Lightweight Python package for exploring bathymetry data."""
+
+import logging
+from importlib.metadata import version
+
+from bathy import profile
+from bathy.analysis import (
+    aspect,
+    bpi,
+    contours,
+    curvature,
+    geomorphons,
+    hypsometric_curve,
+    hypsometric_index,
+    rugosity,
+    slope,
+    smooth,
+    summary,
+)
+from bathy.datasets import sample_data
+from bathy.io import (
+    list_regions,
+    load_bathymetry,
+    load_emodnet_wcs,
+    load_gebco_opendap,
+    to_geotiff,
+)
+from bathy.plot import (
+    plot_aspect,
+    plot_bathy,
+    plot_bpi,
+    plot_curvature,
+    plot_depth_zones,
+    plot_geomorphons,
+    plot_hillshade,
+    plot_histogram,
+    plot_hypsometric_curve,
+    plot_interactive,
+    plot_overview,
+    plot_rugosity,
+    plot_slope,
+    plot_surface3d,
+)
+from bathy.profile import (
+    Profile,
+    compare_stats,
+    concavity_index,
+    cross_sections,
+    extract_profile,
+    get_canyons,
+    gradient,
+    knickpoints,
+    max_depth,
+    profile_from_coordinates,
+    profile_stats,
+    profiles_from_file,
+    profiles_from_gdf,
+    to_gdf,
+)
+from bathy.profile_plot import (
+    plot_canyons,
+    plot_gradient,
+    plot_knickpoints,
+    plot_profile,
+    plot_profiles,
+    plot_profiles_grid,
+    plot_profiles_map,
+)
+
+__version__ = version("bathy")
+
+
+def draw_profile(*args, **kwargs):
+    """Lazy wrapper — see :func:`bathy.draw.draw_profile`."""
+    from bathy.draw import draw_profile as _draw_profile
+
+    return _draw_profile(*args, **kwargs)
+
+
+__all__ = [
+    # Datasets
+    "sample_data",
+    # IO
+    "list_regions",
+    "load_bathymetry",
+    "load_emodnet_wcs",
+    "load_gebco_opendap",
+    "to_geotiff",
+    # Analysis
+    "summary",
+    "hypsometric_index",
+    "hypsometric_curve",
+    "slope",
+    "curvature",
+    "bpi",
+    "rugosity",
+    "aspect",
+    "geomorphons",
+    "contours",
+    "smooth",
+    # Plotting
+    "plot_bathy",
+    "plot_hillshade",
+    "plot_slope",
+    "plot_curvature",
+    "plot_bpi",
+    "plot_rugosity",
+    "plot_aspect",
+    "plot_geomorphons",
+    "plot_overview",
+    "plot_histogram",
+    "plot_depth_zones",
+    "plot_surface3d",
+    "plot_hypsometric_curve",
+    # Profile
+    "Profile",
+    "extract_profile",
+    "profile_from_coordinates",
+    "cross_sections",
+    "profiles_from_file",
+    "profiles_from_gdf",
+    "profile_stats",
+    "max_depth",
+    "gradient",
+    "concavity_index",
+    "knickpoints",
+    "get_canyons",
+    "compare_stats",
+    "to_gdf",
+    "plot_profile",
+    "plot_profiles",
+    "plot_profiles_grid",
+    "plot_profiles_map",
+    "plot_knickpoints",
+    "plot_gradient",
+    "plot_canyons",
+    # Interactive
+    "plot_interactive",
+    "draw_profile",
+    # Submodule
+    "profile",
+    "__version__",
+]
+
+logging.getLogger("bathy").addHandler(logging.NullHandler())

bathy-0.2.0/src/bathy/__main__.py

@@ -0,0 +1,46 @@
+"""Launch the interactive profile drawer from the command line.
+
+Usage
+-----
+    uv run bathy-draw path/to/data.nc
+    uv run python -m bathy path/to/data.nc
+"""
+
+import sys
+from pathlib import Path
+
+
+def main() -> None:
+    if len(sys.argv) < 2:
+        print("Usage: bathy-draw <path/to/data.nc>")
+        sys.exit(1)
+
+    path = Path(sys.argv[1])
+    if not path.exists():
+        print(f"File not found: {path}")
+        sys.exit(1)
+
+    from bathy.draw import draw_profile
+    from bathy.io import load_bathymetry
+    from bathy.profile import to_gdf
+
+    data = load_bathymetry(str(path))
+    profiles = draw_profile(data)
+
+    if not profiles:
+        print("No profiles drawn.")
+        return
+
+    out_path = path.with_name(f"{path.stem}_profiles.gpkg")
+    to_gdf(profiles).to_file(out_path)
+
+    print(f"\n{len(profiles)} profile(s) saved to {out_path}")
+    for p in profiles:
+        print(
+            f"  {p.name}: {p.distances[-1] / 1000:.1f} km, "
+            f"min elevation {float(p.elevations.min()):.0f} m"
+        )
+
+
+if __name__ == "__main__":
+    main()