profinder

This package provides functions for finding profiles in ocean pressure data. It builds on scipy.signal.find_peaks.

See the documentation for more details.

Building the documentation locally

To build and serve the documentation locally:

1. (Recommended) Create a separate environment for docs:

   uv venv .venv-docs
   source .venv-docs/bin/activate
   

2. Install documentation requirements and the package:

   uv pip install --upgrade pip
   pip install -r docs/requirements.txt
   pip install -e .
   

3. Build the documentation:

   cd docs
   make html
   

4. Serve the documentation locally (also runs the build step):

   make serve
   # Then open http://localhost:8000 in your browser
   

Publishing

First generate an API token at pypi.org and store in ~/.pypirc.

Make sure to the bump the version appropriately.

uv version --bump <major/minor/patch>

Remove any existing distributions, build, and publish.

rm -rf dist
uv build
uvx twine upload dist/*