CruisePlan

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.

Quick Start: Quick Start | GitHub https://github.com/ocean-uhh/cruiseplan

User Guide

• Quick Start
  • Installation
  • Your First Cruise
  • Interactive Station Placement
  • What You Get
  • Next Steps
• Workflows
  • Three Common Workflows
  • Interactive Station Picker
  • Tips
• YAML Basics
  • Basic Structure
  • Essential Fields
  • Schedule Organization
  • Operation Types and Actions
  • Coordinates
  • Common Workflow

Reference

• CLI Commands
  • Setup
  • Pre-cruise Planning
  • Individual Processing Steps
  • At Sea
  • Global Options
  • Exit Codes
• YAML Configuration Reference
  • Configuration Structure
  • Coordinate Conventions
  • Units Reference
  • Cruise Metadata
  • Point Operations
  • Line Operations
  • Area Operations
  • Schedule Organization
  • Operation Types
  • Validation Rules
  • Parameter Inheritance
  • Comments and Documentation
  • File Processing
• Output Formats
  • Timeline Formats
  • Map Outputs
  • Document Formats
  • Working Files
  • Output Selection
  • File Naming

Advanced

• API Examples
  • Quick Start
  • Top-Level API
  • Result Types
  • Advanced: CruiseInstance
  • Distance Calculations
  • Working with PANGAEA Data
  • Error Handling
• CruisePlan Demo
  • Workflow Overview
  • Setup and Imports
  • Phase 1: Data Preparation
  • Phase 2: Cruise configuration
  • Phase 3: Cruise scheduling + outputs
  • Workflow Summary
• CruisePlan Developer Guide
  • Module structure
  • Two-layer architecture
  • Entry/exit point interface
  • Adding a new operation type
  • Coordinate input formats
  • Exceptions
  • FlexibleLocationModel
  • Testing
  • Dependencies
• Manual Testing and Verification
  • Run Tests
  • Test Case 1: Single Station (tc1_single.yaml)
  • Test Case 2: Two Legs (tc2_two_legs.yaml)
  • Test Case 3: Clusters (tc3_clusters.yaml)
  • Test Case 4: Mixed Operations (tc4_mixed_ops.yaml)
  • Test Case 5: Sections (tc5_sections.yaml)
  • Running Manual Tests
  • Development Workflow Integration
  • Troubleshooting
  • Extending the Test Suite
• API Reference
  • API Functions
  • Command-line-interface (CLI)
  • Configuration & Validation
  • Data - Bathymetry & Pangaea
  • Interactive pickers
  • Output formats
  • Runtime Classes
  • Timeline & Scheduling
  • General Utilities

Indices and tables

• Index

• Module Index

• Search Page