Metadata-Version: 2.4
Name: cruiseplan
Version: 0.5.0
Summary: Oceanographic Research Cruise Planning System
Maintainer-email: Eleanor Frajka-Williams <eleanorfrajka@gmail.com>
License: MIT License
        
        Copyright (c) 2025 Eleanor Frajka-Williams
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: documentation, https://github.com/ocean-uhh/cruiseplan
Project-URL: homepage, https://github.com/ocean-uhh/cruiseplan
Project-URL: repository, https://github.com/ocean-uhh/cruiseplan
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Scientific/Engineering :: GIS
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy>=2.0.2
Requires-Dist: pandas>=2.3.3
Requires-Dist: xarray>=2024.7.0
Requires-Dist: netCDF4>=1.7.2
Requires-Dist: scipy>=1.13.1
Requires-Dist: requests>=2.32.5
Requires-Dist: pangaeapy>=1.0.22
Requires-Dist: pydantic>=2.13.4
Requires-Dist: ruamel.yaml<0.20.0,>=0.19.1
Requires-Dist: matplotlib>=3.9.4
Requires-Dist: folium
Requires-Dist: branca
Requires-Dist: geopandas>=1.0.1
Requires-Dist: tqdm>=4.67.3
Requires-Dist: jinja2
Provides-Extra: test
Requires-Dist: pytest>=8.4.2; extra == "test"
Requires-Dist: pytest-cov>=7.1.0; extra == "test"
Requires-Dist: pyyaml>=6.0.3; extra == "test"
Provides-Extra: dev
Requires-Dist: cruiseplan[test]; extra == "dev"
Requires-Dist: jupyterlab>=4.5.8; extra == "dev"
Requires-Dist: nbconvert>=7.17.1; extra == "dev"
Requires-Dist: myst-nb>=1.3.0; extra == "dev"
Requires-Dist: nbsphinx>=0.9.8; extra == "dev"
Requires-Dist: sphinx>=7.4.7; extra == "dev"
Requires-Dist: sphinx-rtd-theme>=3.1.0; extra == "dev"
Requires-Dist: pypandoc>=1.17; extra == "dev"
Requires-Dist: myst-parser>=3.0.1; extra == "dev"
Requires-Dist: mock; extra == "dev"
Requires-Dist: black>=26.5.1; extra == "dev"
Requires-Dist: ruff>=0.15.20; extra == "dev"
Requires-Dist: pre-commit>=4.3.0; extra == "dev"
Requires-Dist: codespell; extra == "dev"
Requires-Dist: mypy>=1.19.1; extra == "dev"
Requires-Dist: types-requests; extra == "dev"
Requires-Dist: types-tqdm; extra == "dev"
Requires-Dist: pandas-stubs; extra == "dev"
Dynamic: license-file

# CruisePlan

[![PyPI](https://img.shields.io/pypi/v/cruiseplan.svg)](https://pypi.org/project/cruiseplan/)
[![Python versions](https://img.shields.io/pypi/pyversions/cruiseplan.svg)](https://pypi.org/project/cruiseplan/)
[![License: MIT](https://img.shields.io/pypi/l/cruiseplan.svg)](https://github.com/ocean-uhh/cruiseplan/blob/main/LICENSE)
[![Tests](https://github.com/ocean-uhh/cruiseplan/actions/workflows/tests.yml/badge.svg)](https://github.com/ocean-uhh/cruiseplan/actions/workflows/tests.yml)
[![Documentation](https://img.shields.io/badge/docs-ocean--uhh.github.io-blue.svg)](https://ocean-uhh.github.io/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.

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

---

## Installation

### pip

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

### conda / mamba

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

### Development install

```bash
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

```bash
# 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:

```python
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](https://ocean-uhh.github.io/cruiseplan/usage.html) and [API Reference](https://ocean-uhh.github.io/cruiseplan/api/modules.html) for details.

---

## Changelog

Release notes, including breaking changes, are in [CHANGELOG.md](CHANGELOG.md).

---

## Development

```bash
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](https://orcid.org/0009-0007-0043-9207) and [Sunke Trace-Kleeberg](https://orcid.org/0000-0002-5980-2492). CruisePlan was initially developed by [Yves Sorge](https://orcid.org/0009-0007-0043-9207) and redesigned by [Eleanor Frajka-Williams](https://orcid.org/0000-0001-8773-7838).

If you use CruisePlan in your research, please cite it using [CITATION.cff](CITATION.cff).

---

## Related software

The following tools may also be useful (*untested*):

**Python/GIS:**
- [cruisetools](https://github.com/simondreutter/cruisetools) — QGIS plugin

**Python:**
- [dreamcoat](https://github.com/mvdh7/dreamcoat) — personal cruise planning tools

**R:**
- [cruisePlanning](https://github.com/clayton33/cruisePlanning) — DFO AZMP-based cruise planning
- [cruisetrack-planner](https://github.com/fribalet/cruisetrack-planner) — cruise track planning with Shiny app

**MATLAB:**
- [PlanCampanha](https://github.com/PedroVelez/PlanCampanha) — cruise planning from CSV input
