cruiseplan 0.3.5

Oceanographic Research Cruise Planning System

CruisePlan

🌊 Comprehensive Oceanographic Research Cruise Planning System — Streamlining the process of planning oceanographic research expeditions.

Background & Context

The Challenge: Oceanographic cruise planning involves complex route and timing calculations, frequent unit conversions (nautical miles <-> kilometers, decimal degrees <-> degrees decimal minutes), and rapid plan updates. Different people may need different formats--spreadsheets for quick calculations, degrees/decimal minutes for navigation, kilometers for station spacing, knots for voyage timing. Using historical station locations may be preferred, but can be tricky to access.

• Fragmented Tools: Scattered spreadsheets, manual calculations, custom code snippets
• Time-Intensive Processes: Semi-manual station planning, timing calculations, and proposal formatting
• Error-Prone Workflows: Manual depth lookups, coordinate formatting, and schedule validation

The Solution: CruisePlan provides an integrated, semi-automated system for an efficient cruise-planning workflow.

Target Audience

Primary Users:

• 🔬 Oceanographic Researchers: Principal investigators designing research expeditions
• 📊 Students: Graduate students learning cruise planning methodology
• 📋 Proposal Writers: Scientists preparing funding proposals with detailed cruise plans

Research Domains: The primary development of CruisePlan is for physical oceanographers, with CTD stations, mooring deployments and glider operations as default. However, it is possible to incorporate any type of point, line or area operation of a ship with a specified manual duration based on your own experience.

CruisePlan transforms complex cruise planning from a weeks-long manual process into a structured, validated workflow that produces proposal-ready documentation with some checks on operational feasibility.

⚠️ Breaking Changes in v0.3.0: Commands cruiseplan download and cruiseplan pandoi have been removed. Parameter names shortened (--bathymetry-* → --bathy-*). See MIGRATION_v0.3.0.md for migration guide and CHANGELOG.md for complete changes.

⚠️ Breaking Changes in v0.3.3: YAML configuration now uses transects: instead of transits: for scientific line operations and waypoints: instead of stations: for point operations.

Disclaimer: This software is provided "as is" without warranty of any kind. Users are responsible for validating all calculations, timing estimates, and operational feasibility for their specific cruise requirements. Always consult with marine operations staff and verify all outputs before finalizing cruise plans.

📘 Full documentation available at:
👉 https://ocean-uhh.github.io/cruiseplan/

---

🚀 What's Included

• ✅ Interactive station planning: Click-to-place stations on bathymetric maps with real-time depth feedback
• 📓 PANGAEA integration: Browse and incorporate past cruise data for context
• 📄 Multi-format outputs: Generate NetCDF, LaTeX reports, PNG maps, KML files, and CSV data
• 🔍 Cruise validation: Automated checking of cruise configurations and operational feasibility
• 🎨 Documentation: Sphinx-based docs with API references and usage guides
• 📦 Modern Python packaging: Complete with testing, linting, and CI/CD workflows
• 🧾 Scientific citation support: CITATION.cff for academic attribution

---

Project structure

For a detailed breakdown of the package architecture and module descriptions, see the Project Structure Documentation.

cruiseplan/
├── .github/
│   └── workflows/              # GitHub Actions for tests, docs, PyPI
├── docs/                       # Sphinx-based documentation
│   ├── source/                 # reStructuredText + MyST Markdown + _static
│   └── Makefile                # for building HTML docs
├── notebooks/                  # Example notebooks and demos
├── cruiseplan/                 # Main Python package
│   ├── calculators/            # Distance, duration, routing calculators
│   ├── cli/                    # Command-line interface modules
│   ├── core/                   # Core cruise planning logic
│   ├── data/                   # Bathymetry and PANGAEA data handling
│   ├── interactive/            # Interactive station picking tools
│   ├── output/                 # Multi-format output generators
│   ├── processing/             # Configuration processing and enrichment
│   ├── utils/                  # Utilities and coordinate handling
│   └── validation/             # Schema validation and configuration models
├── tests/                      # Comprehensive pytest test suite
│   ├── cli/                    # CLI command tests
│   ├── core/                   # Core logic tests
│   ├── fixtures/               # Test data and configurations
│   ├── integration/            # Integration and workflow tests
│   └── unit/                   # Unit tests by module
├── data/                       # Bathymetry datasets
├── .gitignore
├── .pre-commit-config.yaml
├── CITATION.cff                # Citation file for academic use
├── CONTRIBUTING.md             # Contribution guidelines
├── LICENSE                     # MIT license
├── README.md
├── pyproject.toml              # Modern packaging config
├── requirements.txt            # Core package dependencies
├── requirements-dev.txt        # Development and testing tools
└── environment.yml             # Conda environment specification

---

🔧 Installation

Option 1: Install from PyPI (Most Users)

For general use, install the latest stable release from PyPI. Note: CruisePlan is in active development (0.x versions) with occasional breaking changes.

# Create virtual environment
python -m venv .venv
source .venv/bin/activate  # Windows: .venv\Scripts\activate

# Install CruisePlan
pip install cruiseplan

Option 2: Install Latest from GitHub

For the latest features and bug fixes:

# Create virtual environment
python -m venv .venv
source .venv/bin/activate  # Windows: .venv\Scripts\activate

# Install directly from GitHub
pip install git+https://github.com/ocean-uhh/cruiseplan.git

Option 3: Development Installation

For development or contributing to CruisePlan:

# Clone the repository
git clone https://github.com/ocean-uhh/cruiseplan.git
cd cruiseplan

# Option A: Using conda/mamba
conda env create -f environment.yml
conda activate cruiseplan
pip install -e ".[dev]"

# Option B: Using pip with virtual environment
python -m venv .venv
source .venv/bin/activate  # Windows: .venv\Scripts\activate
pip install -e ".[dev]"

Dependencies: Core packages are listed in requirements.txt, development tools in requirements-dev.txt. The conda environment.yml loads from these files automatically.

To run tests:

pytest tests/

To build the documentation locally:

cd docs
make html

---

📚 Learn More

• Installation Guide
• Usage Guide
• API Reference
• Development Roadmap

---

🤝 Contributing

Contributions are welcome! Please see our Contributing Guidelines for details on how to get started.

For information about planned improvements and development priorities, see our Development Roadmap.

---

🙏 Acknowledgments & Citation

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

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

---

Related Software

The following cruise planning tools may also be of interest (Disclaimer: We have not tested these):

Python/GIS:

• cruisetools - Python plugin for QGIS.

Python:

• dreamcoat - Personal tools for cruise planning

R:

• cruisePlanning - R package for cruise planning based on DFO's AZMP
• cruisePlanningStatic - similar to the above
• cruisetrack-planner - Cruise track planning in R plus Shiny App (https://seaflow.shinyapps.io/cruisetrackplanner/)

MATLAB:

• PlanCampanha - Cruise planning with CSV as input