Bump to v0.1.12

Author: chrisleaman

.gitignore

@@ -106,3 +106,4 @@ ENV/
 # Editor configs
 /.idea/
 .vscode/settings.json
+.claude

.isort.cfg

@@ -0,0 +1,61 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Project Overview
+
+This is a Python package called `py-wave-runup` that implements empirical wave runup models for coastal engineers and scientists. Wave runup refers to the final part of a wave's journey as it travels from offshore onto the beach, comprising:
+
+- **setup**: time averaged superelevation of mean water level above SWL
+- **swash**: time varying fluctuation of instantaneous water level about setup elevation
+
+## Architecture
+
+The codebase is organized into several key modules:
+
+- **`py_wave_runup/models.py`**: Core module containing empirical wave runup models (Stockdon2006, Power2018, Holman1986, Nielsen2009, etc.). All models inherit from abstract `RunupModel` base class with parameters Hs (significant wave height), Tp (peak wave period), beta (beach slope), and optional Lp, h, r.
+
+- **`py_wave_runup/ensembles.py`**: Ensemble techniques to combine predictions from multiple models, starting with `EnsembleRaw` base class.
+
+- **`py_wave_runup/datasets.py`**: Interface for loading wave runup datasets as pandas DataFrames for model evaluation and training. Uses scikit-learn preprocessing and custom Perlin noise utilities.
+
+- **`py_wave_runup/utils.py`**: Utility functions including `PerlinNoise` for synthetic data generation.
+
+## Development Commands
+
+### Environment Setup
+- **uv with existing venv**: `uv sync --active` (uses C:\Users\Chris\venv\py-wave-runup)
+- **uv with dev dependencies**: `uv sync --active --dev` (includes development dependencies)
+- **Alternative**: `pip install -e ".[dev]"` (if not using uv)
+
+**Note**: The preferred virtual environment location is `C:\Users\Chris\venv\py-wave-runup`. Use `--active` flag to target this environment.
+
+### Testing
+- **Run all tests**: `uv run --active pytest`
+- **Run with coverage**: `uv run --active pytest --cov=py_wave_runup --cov-report term-missing`
+- **Run doctests**: Tests include doctests via `--doctest-modules` flag
+
+### Code Quality
+- **Pre-commit hooks**: `uv run --active pre-commit install` then `uv run --active pre-commit run -a`
+- **Black formatting**: `uv run --active black .`
+
+### Documentation
+- **Build docs**: `uv run --active sphinx-build -M html ".\docs" ".\docs\_build"`
+- **Documentation hosted at**: https://py-wave-runup.readthedocs.io
+
+### Build and Publishing
+- **Build package**: `uv build`
+- **Build wheel only**: `uv build --wheel`
+- **Publish to PyPI**: `uv publish`
+- **Publish to Test PyPI**: `uv publish --publish-url https://test.pypi.org/legacy/`
+- **Check package**: `uv run --active twine check dist/*`
+
+### Dependencies
+- **Core**: numpy>=1.24, pandas>=2.0, joblib>=1.3, scikit-learn>=1.3
+- **Dev**: pytest, black, sphinx, coverage, pre-commit, matplotlib
+- **Python**: 3.10+ (supports up to 3.14)
+- **Build system**: Uses hatchling backend with uv package manager
+
+## Key Models Available
+
+The package implements 9+ empirical wave runup models including Stockdon2006 (most widely used), Power2018 (Gene-Expression Programming), Beuzen2019 (Gaussian Process), and others. Each model accepts offshore wave conditions and returns runup predictions via properties like `R2`, `setup`, `sinc`, `sig`.

.pre-commit-config.yaml

@@ -11,9 +11,6 @@ Python Wave Runup
 .. image:: https://img.shields.io/pypi/v/py-wave-runup.svg
         :target: https://pypi.python.org/pypi/py-wave-runup
 
-.. image:: https://img.shields.io/travis/com/chrisleaman/py-wave-runup.svg
-        :target: https://travis-ci.com/chrisleaman/py-wave-runup
-
 .. image:: https://readthedocs.org/projects/py-wave-runup/badge/?version=latest
     :target: https://py-wave-runup.readthedocs.io/en/latest/?badge=latest
     :alt: Documentation Status
@@ -41,10 +38,14 @@ Contents
 Installation
 ------------
 
-Installation of ``py-wave-runup`` can be done with pip:
+Installation of ``py-wave-runup`` can be done with uv or pip:
 
 .. code:: bash
 
+    # Using uv (recommended)
+    uv add py-wave-runup
+
+    # Using pip
     pip install py-wave-runup
 
 
@@ -139,21 +140,39 @@ to create a Pull Request:
 1. Fork it (https://github.com/chrisleaman/py-wave-runup/fork)
 2. Create the development environment:
 
-    - For pip, run ``pip install --pre -r requirements.txt``
-    - For `poetry`_, run ``poetry install``
-    - For `anaconda`_, run ``conda env create --name <env_name> -f environment.yml``
+    - Using `uv`_ (recommended): ``uv sync --dev``
+    - For pip: ``pip install -e ".[dev]"``
 
 3. Create your feature branch (``git checkout -b feature/fooBar``)
-4. Install pre-commit hooks for automatic formatting (``pre-commit run -a``)
+4. Install pre-commit hooks for automatic formatting (``uv run pre-commit install``)
 5. Add your code!
-6. Add and run tests (``pytest``)
-7. Update and check documentation compiles (``sphinx-build -M html ".\docs" ".\docs\_build"``)
-8. Commit your changes (``git commit -am 'Add some fooBar``)
+6. Add and run tests (``uv run pytest``)
+7. Update and check documentation compiles (``uv run sphinx-build -M html ".\docs" ".\docs\_build"``)
+8. Commit your changes (``git commit -am 'Add some fooBar'``)
 9. Push to the branch (``git push origin feature/fooBar``)
 10. Create a new Pull Request
 
-.. _poetry: https://python-poetry.org/
-.. _anaconda: https://www.anaconda.com/distribution/#download-section
+.. _uv: https://docs.astral.sh/uv/
+
+
+Publishing
+----------
+
+To build and publish the package to PyPI:
+
+.. code:: bash
+
+    # Build the package
+    uv build
+
+    # Check the package (optional)
+    uv run --active twine check dist/*
+
+    # Publish to Test PyPI first (recommended)
+    uv publish --publish-url https://test.pypi.org/legacy/
+
+    # Publish to PyPI
+    uv publish
 
 
 Citation

.travis.yml

@@ -20,12 +20,12 @@
 
 # -- Project information -----------------------------------------------------
 
+
 # Get project version from pyproject.toml file
-# https://github.com/python-poetry/poetry/issues/273#issuecomment-427647628
 def _get_project_meta():
     with open("../pyproject.toml") as pyproject:
         file_contents = pyproject.read()
-    return tomlkit.parse(file_contents)["tool"]["poetry"]
+    return tomlkit.parse(file_contents)["project"]
 
 
 project = "py-wave-runup"
@@ -115,6 +115,7 @@ def _get_project_meta():
 
 # Autodoc options
 
+
 # Define what classes to skip
 def autodoc_skip_member(app, what, name, obj, skip, options):
     exclusions = ("RunupModel",)

CLAUDE.md

@@ -5,9 +5,6 @@ Python Wave Runup
 .. image:: https://img.shields.io/pypi/v/py-wave-runup.svg
         :target: https://pypi.python.org/pypi/py-wave-runup
 
-.. image:: https://img.shields.io/travis/com/chrisleaman/py-wave-runup.svg
-        :target: https://travis-ci.com/chrisleaman/py-wave-runup
-
 .. image:: https://readthedocs.org/projects/py-wave-runup/badge/?version=latest
     :target: https://py-wave-runup.readthedocs.io/en/latest/?badge=latest
     :alt: Documentation Status

README.rst

@@ -2,23 +2,24 @@
 Installation
 ------------
 
-If you don't have Python installed, Anaconda_ is an easy way to get up and running with Python.
-
-.. _Anaconda: https://docs.anaconda.com/anaconda/install/
-
-
-Installation of ``py-wave-runup`` can be done with ``pip``. Run this command in your
-terminal of choice to grab the latest release of this package:
+Installation of ``py-wave-runup`` can be done with uv or pip:
 
 .. code:: bash
 
+    # Using uv (recommended)
+    uv add py-wave-runup
+
+    # Using pip
     pip install py-wave-runup
 
-If you've installed an older version and want to upgrade to the latest version, run
-this command:
+If you've installed an older version and want to upgrade to the latest version:
 
 .. code:: bash
 
+    # Using uv
+    uv add py-wave-runup --upgrade
+
+    # Using pip
     pip install --upgrade py-wave-runup
 
 After you're up and running, head on over to :doc:`usage` for some examples of what