rustyroute

A Rust library for shortest-path maritime route computation.

Status: pre-release. This repository contains the EUPL-1.2 legal/governance scaffolding, the vendored Eurostat MARNET data, and a build.rs that compiles the MARNET GeoPackages into rkyv graph archives at build time. Graph::load/Graph::from_bytes and Dijkstra routing (Graph::route) have landed; distance matrices and further algorithms follow in later tickets — see CONTRIBUTING.md for the scope policy.

Installation

Not yet published to crates.io. Once published:

cargo add rustyroute

Usage

Load a graph and compute a route. Coordinates are (lat, lng) in decimal degrees:

use rustyroute::Graph;
use std::collections::HashSet;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let graph = Graph::load(50)?; // 50 km resolution

    let route = graph.route(
        (43.30, 5.37),   // Marseille
        (31.23, 121.47), // Shanghai
        &HashSet::new(), // no blocked edges
    )?;
    println!("{:.1} km", route.distance_km);

    // Avoid a chokepoint: resolve one or more of the 13 baked-in edge
    // groups (see `rustyroute::EDGE_GROUPS`) and pass them to `route`.
    let blocked = graph.edges_for_groups(["suezCanal"])?;
    let around_africa = graph.route((34.0, 28.0), (20.0, 38.0), &blocked)?;
    println!("{:.1} km avoiding Suez", around_africa.distance_km);

    Ok(())
}

The data-{N}km features control which resolutions are baked into the binary; data-50km is the default. Graph::load also honours $RUSTYROUTE_DATA_DIR for loading archives from disk.

CLI

An optional rustyroute binary is available behind the cli feature. It is not built by default, so library-only consumers never compile clap:

cargo install --path . --features cli

rustyroute route --from 43.30,5.37 --to 31.23,121.47

Flag	Values	Default
--from / --to	lat,lng decimal degrees	required
--resolution	5, 10, 20, 50, 100 (km)	50
--block	comma-separated edge groups, e.g. suezCanal,menaiStrait	none
--format	json, geojson, line	geojson

The cli feature also enables every data-{N}km feature so an installed binary can serve any --resolution.

Results go to stdout, diagnostics to stderr. Exit codes:

Code	Meaning
0	route found
1	bad arguments
2	no route between the endpoints
3	graph data unavailable for the requested resolution
4	failed to write output

Attribution

rustyroute is based on and inspired by Eurostat's SeaRoute project. SeaRoute is published under EUPL-1.2 by the European Union (Eurostat). See NOTICE for full attribution.

Contributing

See CONTRIBUTING.md. All commits must be signed off under the Developer Certificate of Origin.

Security

See SECURITY.md. Do not report vulnerabilities via public issues.

License

Licensed under the European Union Public Licence v. 1.2 (EUPL-1.2).