Seascape Toolkit

The shape, composition, and connectivity of the marine environment.

Documentation site · Variables · Methods · Examples

Seascape Toolkit turns reviewed geospatial sources into reproducible physical and structural marine features. It supports bathymetry and terrain, modeled substrate, shoreline and waterbody geometry, freshwater connections, mapped vegetation and reef evidence, built coastal features, and the H3 water support that relates them. It is an independently installable Python package; no OrcaCast checkout is required.

The toolkit is for researchers, GIS users, and downstream applications that need analysis-ready features with source lineage, spatial support, and explicit missingness. Physical conditions and mapped evidence do not establish species occurrence or habitat suitability. Regional source data and an audited regional release are not bundled.

v0.1.1 status and compatibility

v0.1.1 is a public preview, not a stable 1.0 contract. It supports Python 3.14 on the Linux x86_64 and macOS ARM64 environments exercised by CI. Other operating systems are not currently claimed. During 0.x, documented minor releases may change APIs, CLI behavior, schemas, variables, or scientific methods; patch releases preserve intended public and scientific contracts.

The toolkit records source lineage, configuration, checksums, spatial support, missingness, and versioned scientific interpretations so results can be reproduced and compared. Those records do not remove source-specific limitations: regional coverage, rights, horizontal CRS, vertical datum, resolution, and accuracy must be reviewed for each data release. The synthetic demo does not validate regional accuracy, species habitat, navigation safety, or predictive fitness.

Software, scientific interpretation, and materialized data have deliberately separate identities. See the release process and changelog for the identity model, Semantic Versioning policy, method changes, and immutable-release rules. Rebuilding data does not by itself create a Python package version, Git tag, or GitHub Release.

Install and get a first result

After publication to PyPI, install the software with Python 3.14:

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

For a reproducible installation, pin a published version, for example python -m pip install toolkit-seascape==0.1.1 once that version is available on PyPI. Installation retrieves declared Python dependencies; the package does not include regional scientific datasets or an audited data release.

Contributors and maintainers validating the source-install quick start can clone the repository and run the following from its root. This exercised source path also checks the documentation example:

SEASCAPE_ENV="$PWD/.venv"
python3.14 -m venv "$SEASCAPE_ENV"
. "$SEASCAPE_ENV/bin/activate"
python -m pip install 'pip>=26.2'
python -m pip install .
python -m pip check

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

Leave the checkout and select a fresh owned workspace:

cd "$(mktemp -d "${TMPDIR:-/tmp}/seascape-first-result.XXXXXX")"
export SEASCAPE_WORKSPACE="$PWD/seascape-workspace"
seascape --workspace "$SEASCAPE_WORKSPACE" demo

The CLI prints Synthetic software acceptance: PASS (not a regional release) after validating the production bathymetry transform on synthetic inputs. It reports paths to Parquet, manifest, JSON report, and figures under $SEASCAPE_WORKSPACE/.seascape/demo/. Missing depth stays null; this is a software check, not a regional accuracy claim. See the full quick start and demo guide.

What to read next

Goal	Documentation
Install and configure	Installation · Configuration
Find exact fields and coverage limits	Variable catalog · Product index · Capability coverage
Review sources and calculations	Data sources · Methodology · Scientific contracts
Process real inputs	Bounded workflow · Stage prerequisites
Read a completed release	Python API · Metric matrix
Contribute or release	Development guide · Release process · Documentation site source

Source rights and attribution are provider-specific; the software license is Apache-2.0. The documentation site is built with MkDocs Material and deployed from main by GitHub Actions. Contributors can run it locally with python -m pip install -e ".[docs]", mkdocs serve, and mkdocs build --strict.