CruisePlan v0.3.5 Logo

User Guide

  • Quick Start
  • Workflows
  • YAML Basics

Reference

  • CLI Commands
  • YAML Configuration Reference
  • Output Formats

Advanced

  • API Examples
  • CruisePlan Demo
  • CruisePlan Developer Guide
  • Manual Testing and Verification
  • Development Workflow Integration
  • API Reference
CruisePlan v0.3.5
  • Legacy Documentation

Legacy Documentation

This section contains detailed technical documentation preserved from previous versions of CruisePlan.

  • Installation
    • System Requirements
    • Install options (PyPI, GitHub)
    • Core Dependencies
    • Troubleshooting
    • Getting Help
  • Usage Overview
    • Three-Phase Workflow
    • YAML Configuration Structure
    • How to Get Started
  • Calculation Methods
    • Distance Calculations
    • Duration Calculations
    • Map Visualization vs Distance Calculations
  • Units and Defaults
    • Quick Reference
    • Standard Units
    • Time and Duration Formats
    • Coordinate Systems
    • Depth Convention
    • Default Configuration Values
    • Examples by Use Case
    • Advanced Topics
  • Global Ports Reference
    • Usage in YAML
    • Available Global Ports
    • Programmatic Access
    • Regional Filtering
    • Custom Port Definitions
    • Adding Custom Ports at Runtime
  • Example CruisePlan YAML Configuration
  • Cruise Architecture
    • Overview
    • Hierarchical Grouping System
    • Design Principles
    • Data Models
    • Runtime Objects
    • Port System
    • Scheduling Logic
    • Configuration Examples
    • Development Guidelines
    • Migration from Legacy Architecture
    • Architecture Benefits
    • Performance Considerations
  • Project Structure
    • Directory Structure
    • Key Design Principles

These files provide comprehensive technical details for advanced users and developers working with earlier CruisePlan architectures.


Built with Sphinx using a theme provided by Read the Docs.