Skip to main content

CruisePlan

PyPI Python versions License: MIT Tests Documentation

CruisePlan is a Python tool for planning oceanographic research cruises. It takes a YAML cruise description and produces enriched configurations, cruise schedules, maps (PNG/KML), LaTeX station tables, and real-time workplans.

Full documentation: https://ocean-uhh.github.io/cruiseplan/


Installation

pip

python -m venv .venv
source .venv/bin/activate        # Windows: .venv\Scripts\activate
pip install cruiseplan

conda / mamba

conda create -n cruiseplan -c conda-forge python=3.11
conda activate cruiseplan
pip install cruiseplan

Development install

git clone https://github.com/ocean-uhh/cruiseplan.git
cd cruiseplan

# Using conda/mamba (includes dev dependencies)
conda create -n cruiseplan -c conda-forge python=3.11
conda activate cruiseplan
pip install -e ".[dev]"

# Using venv
python -m venv .venv
source .venv/bin/activate
pip install -e ".[dev]"

Quick start

# Enrich a YAML config, generate schedule and map
cruiseplan process cruise.yaml
cruiseplan schedule cruise_enriched.yaml
cruiseplan map cruise_enriched.yaml

Or use the Python API:

import cruiseplan

# Process and schedule in one step
process_result, schedule_result = cruiseplan.run("cruise.yaml")
print(schedule_result.files_created)

See the Usage Guide and API Reference for details.


Changelog

Release notes, including breaking changes, are in CHANGELOG.md.


Development

pytest tests/
cd docs && make html

Disclaimer: This software is provided without warranty. Users are responsible for validating all calculations, timing estimates, and operational feasibility before finalising cruise plans.


Acknowledgments

The original timing algorithms were developed by Yves Sorge and Sunke Trace-Kleeberg. CruisePlan was initially developed by Yves Sorge and redesigned by Eleanor Frajka-Williams.

If you use CruisePlan in your research, please cite it using CITATION.cff.


The following tools may also be useful (untested):

Python/GIS:

Python:

  • dreamcoat — personal cruise planning tools

R:

MATLAB:

Metadata

Release files for cruiseplan 0.5.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for cruiseplan 0.5.0
File Size Uploaded Provenance Actions
cruiseplan-0.5.0.tar.gz 29.0 MB With provenance Details for cruiseplan-0.5.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for cruiseplan 0.5.0
File Interpreter ABI Platform Actions
cruiseplan-0.5.0-py3-none-any.whl Python 3 none any Details for cruiseplan-0.5.0-py3-none-any.whl

Total release size: 29.3 MB

Release files / cruiseplan-0.5.0.tar.gz

Download URL cruiseplan-0.5.0.tar.gz
Size 29.0 MB
Tags Source
SHA-256 checksum
How to use checksums
8937a3a90374d79d3f43e506d417449a1c0f410024539674c0e3415f72083fff
BLAKE2b-256 checksum
How to use checksums
841cb586d1f4f15767d10ac4fe3ed05a80ccf7c55cf6234b8105ff76f1b5a552
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 2, 2026.

Transparency log

Release files / cruiseplan-0.5.0-py3-none-any.whl

Download URL cruiseplan-0.5.0-py3-none-any.whl
Size 262.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
ea041f5a74e1c3d2999b61df643ba94e1b26d5c1a3be75c4110819fe58420e05
BLAKE2b-256 checksum
How to use checksums
eca9b7a9758912fb6cd8b449501ab4ffc71e674bff320f94ebe8b4225c602e2f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 2, 2026.

Transparency log

Security for cruiseplan 0.5.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for cruiseplan-0.5.0.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 2, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page