Installation¶

SeapoPym uses uv for dependency management and is structured as a monorepo workspace.

Requirements¶

If you don't have uv installed, follow the official installation guide:

Clone the repository and install:

git clone https://github.com/SeapoPym/seapopym.git
cd seapopym
uv sync

This installs both seapopym and seapopym-optimization packages in editable mode.

If you only need the core model:

uv pip install -e packages/seapopym

To install both core and optimization:

uv pip install -e packages/seapopym -e packages/seapopym-optimization

Test that everything works:

import seapopym
print(f"SeapoPym installed successfully!")

For contributing or running tests:

uv sync --group dev

This installs pytest, ruff, mypy, and other development tools.

To build the documentation locally:

uv sync --group docs

Once installed, check out the Quick Start Guide to run your first model!