Route Graph Generator

Présentation

Route Graph Generator (r2gg) est un script Python qui permet la génération de graphes pour des moteurs de calcul d'itinéraire. Il a été développé pour générer les données directement utilisable par Road2.

Actuellement, il y a trois formats de sortie : OSRM, pgRouting et Valhalla.

La conversion se fait via les fonctions de la bibliothèque r2gg développée dans ce but. Une documentation plus détaillée de r2gg est consultable ici.

Génerer des données en local

Un docker compose est mis à disposition pour générer des données Valhalla en local.

UID=$(id -u) GID=$(id -g) docker compose up --build

Les données se trouveront dans le dossier ./data/generation

Le docker compose lance aussi un serveur road2, pour lancer un calcul d'itinéraire, copier le lien suivant

http://localhost:8080/simple/1.0.0/route?resource=bdtopo-valhalla&profile=pedestrian&start=2.320041,48.8588897&end=2.3380277,48.8611473

Pour faire tourner un service test valhalla sans la surcouche road2 sur les données générées, utiliser la commande suivante:

docker run valhalla --user $(id -u):$(id -g) -p 8002:8002 -v ${PWD}/data/generation:/custom_files -e use_tiles_ignore_pbf=True -e force_rebuild=False -e build_admins=False ghcr.io/valhalla/valhalla-scripted:latest

Puis checker la création d'itinéraire via le lien suivant

http://localhost:8002/route?json={"locations":[{"lat": 48.8588897, "lon": 2.320041},{"lat": 48.8611473, "lon": 2.3380277}],"costing":"pedestrian","costing_options":{"pedestrian":{"walking_speed": 4}},"directions_options":{"format":"osrm"}}

Prérequis

Les prérequis au fonctionnement des scripts de génération sont décrits dans le readme de l'image docker.

Les extensions SQL postgres_fdw et PostGIS doivent être installées sur la base de données pivot :

pivot=# CREATE EXTENSION postgres_fdw;
pivot=# CREATE EXTENSION PostGIS;

Dans le cas d'une convertion vers une base de données pgRouting, les extensions SQL postgres_fdw, PostGIS et pgRouting doivent être installées sur la base de données de destination, pgrouting par exemple :

pgrouting=# CREATE EXTENSION postgres_fdw;
pgrouting=# CREATE EXTENSION PostGIS;
pgrouting=# CREATE EXTENSION pgRouting;

Les procédures du projet pgrouting-procedures doivent également être installées sur la base de données de destination, sur le bon schema

Installation

Pour installer les commandes de génération de données, lancer la commande suivante à la racine du projet :

pip3 install --user -e .

Utilisation

Fichier de configuration

Pour pouvoir lancer les scripts de génération, il faut définir une configuration (au format JSON) par ressource à générer. Ce fichier de configuration fait références à d'autres fichiers de configuration : pour la gestion des logs, la gestion des connexions aux bases de données, et pour le calcul des coûts. Des exemples de tous ces fichiers sont présents dans le dépôt dans le dossier io. La documentation de ces fichiers de configuration est consultable ici.

Un exemple de ces fichiers est disponible dans la partie docker.

Exécution

Les scripts de génération sont divisés en trois processus distincts : l'extraction des données d'une base de données vers une base de données dite "pivot", et, en fonction de la ressource, la conversion depuis la base "pivot" vers une base pgRouting, ou vers des fichiers .osrm, ou encore vers des fichiers valhalla.

Ces trois processus se lancent à l'aide de commandes différentes, prenant toutes le même fichier de configuration.

Pour extraire les données vers la base pivot

r2gg-sql2pivot config.json

Pour convertir les données au fromat pgRouting (le type de ressource dans config.json doit être pgr)

r2gg-pivot2pgrouting config.json

Pour convertir les données au format osrm (le type de ressource dans config.json doit être osrm)

r2gg-pivot2osm config.json
r2gg-osm2osrm config.json

Pour convertir les données au format valhalla (le type de ressource dans config.json doit être valhalla)

r2gg-pivot2osm config.json
r2gg-osm2valhalla config.json

Optionnellement, vous pouvez activer le téléchargement et nettoyage GTFS avant r2gg-osm2valhalla en ajoutant un bloc gtfs dans chaque source Valhalla du fichier config.json:

{
	"gtfs": {
		"enabled": true,
		"apiUrl": "https://transport.data.gouv.fr/api/datasets",
		"getOutputDir": "/home/docker/data/generation/gtfs_in",
		"cleanOutputDir": "/home/docker/data/generation/gtfs_clean",
		"transitDir": "/home/docker/data/generation/transit_tiles"
	}
}

Quand enabled est à true, le pipeline GTFS est exécuté avant la génération Valhalla et le fichier processing_report.json est copié dans le dossier de travail (generation.workingSpace.directory).

Enfin, si on souhaite générer la configuration pour Road2, il y a une dernière commande

r2gg-road2config config.json

Version

Elle est indiquée dans le __about__.py.

Licence

Route-graph-generator est diffusé sous la licence GPL v3.

Participer aux développements

Les participations à ce projet sont encouragées (votre notre charte à ce sujet). Nous avons mis en place un guide des contributions pour vous accompagner dans cette démarche.