Skip to content

Installation

Seascape Toolkit is an independently installable Python package with a seascape command. The current package metadata requires Python 3.14. After PyPI publication, normal users can install it without a source checkout:

python3.14 -m venv .venv
source .venv/bin/activate
python -m pip install --upgrade pip
python -m pip install toolkit-seascape
python -m pip check
seascape --help

To reproduce a specific published software version, use python -m pip install toolkit-seascape==0.1.1 once that version is on PyPI. Installation downloads declared Python dependencies. The package does not install regional rasters, shoreline inventories, or an audited data release. Review tested environments if native geospatial dependencies need troubleshooting.

Install from source for development

Clone the repository and install from its root when contributing or validating the source checkout:

git clone https://github.com/MarineCast/toolkit-seascape.git
cd toolkit-seascape
python3.14 -m venv .venv
. .venv/bin/activate
python -m pip install 'pip>=26.2'
python -m pip install .
python -m pip check
seascape --help

For iterative development, use python -m pip install -e '.[test,docs,quality]' from the cloned checkout.

Select a workspace

Use a directory you own for inputs, candidate products, and demo output. The command below initializes editable configuration but does not acquire source datasets:

export SEASCAPE_WORKSPACE="/absolute/path/to/your/seascape-workspace"
seascape --workspace "$SEASCAPE_WORKSPACE" init

An offline first result needs no prior initialization; follow the quick start. For real data, inspect configuration and required stage inputs before running builders.

Work on this documentation site

From the repository root, install the documentation extra in an isolated Python 3.14 environment:

python -m pip install -e '.[docs]'
mkdocs serve

Open http://127.0.0.1:8000/toolkit-seascape/. Before a pull request, run mkdocs build --strict and python scripts/check_docs.py. The generated site/ directory is ignored by Git; the deployment workflow uploads it as a Pages artifact.