.. CruisePlan documentation master file.

=======================================
CruisePlan: Oceanographic Planning Hub
=======================================

Welcome to the official documentation for **CruisePlan** — the comprehensive software tool designed for planning and documenting oceanographic research cruises.

CruisePlan assists researchers in designing optimal station layouts, calculating precise operational timings, and generating professional proposal outputs adhering to scientific standards like CF conventions.

.. toctree::
   :maxdepth: 2
   :caption: Getting Started

   installation.rst
   usage.rst

.. toctree::
   :maxdepth: 2
   :caption: Project Specifications

   Development Roadmap <https://github.com/ocean-uhh/cruiseplan/blob/main/PROJECT_SPECS.md>
   NetCDF Data Standards <netcdf_outputs.md>

.. toctree::
   :maxdepth: 2
   :caption: Help and Reference

   Contributing Guidelines <https://github.com/ocean-uhh/cruiseplan/blob/main/CONTRIBUTING.md>
   GitHub Repository <https://github.com/ocean-uhh/cruiseplan>
   CLI Command Reference <cli_reference.rst>
   API Reference <api/modules.rst>

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`