Feature/pipe ramming model

.github/workflows/pr.yaml

@@ -0,0 +1,28 @@
+# SPDX-FileCopyrightText: Contributors to the utility-route-project and Alliander N.V.
+#
+# SPDX-License-Identifier: Apache-2.0
+
+name: Quality checks
+on:
+  pull_request:
+    types: [opened, reopened, synchronize, closed]
+jobs:
+  quality_checks:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - uses: actions/setup-python@v6
+        with:
+          python-version: 3.12
+      - name: Install Poetry
+        shell: bash
+        run: pipx install poetry~=2.0
+      - name: Install project
+        shell: bash
+        run: poetry install
+      - name: Run pre-commit
+        shell: bash
+        run: poetry run pre-commit run --all-files
+      - name: Run unit and integration tests
+        shell: bash
+        run: poetry run pytest tests

.gitignore

@@ -81,3 +81,6 @@ dmypy.json
 # Pycharm
 .idea
 _viminfo
+
+# VS Code
+.vscode

.pre-commit-config.yaml

@@ -4,7 +4,7 @@
 
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v5.0.0
+    rev: v6.0.0
     hooks:
       - id: trailing-whitespace
       - id: end-of-file-fixer
@@ -22,17 +22,17 @@ repos:
         args: ['--unsafe']
       - id: name-tests-test
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.11.6
+    rev: v0.15.12
     hooks:
-      - id: ruff
-        args: ["--fix"]
+      - id: ruff-check
+        args: [ --fix ]
       - id: ruff-format
   - repo: https://github.com/fsfe/reuse-tool
-    rev: v5.0.2
+    rev: v6.2.0
     hooks:
       - id: reuse-lint-file
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.15.0
+    rev: v1.20.2
     hooks:
     - id: mypy
       args: [--ignore-missing-imports]

PROJECT_GOVERNANCE.md

@@ -1,5 +1,5 @@
 <!--
-SPDX-FileCopyrightText: 'Copyright Contributors to the Utility-route-planner project' 
+SPDX-FileCopyrightText: 'Copyright Contributors to the Utility-route-planner project'
 
 SPDX-License-Identifier: Apache-2.0
 -->

README.md

@@ -84,7 +84,7 @@ requests to us.
 # License
 This project is licensed under the Apache-2.0 - see [LICENSE](https://github.com/alliander-opensource/utility-route-planner/blob/main/LICENSE) for details.
 
-## Licenses data 
+## Licenses data
 This project is largely dependent on data. Data is incorporated in the example folder and is licensed under their own respective Open-Source licenses:
 
 - BGT: [CC PDM 1.0](https://creativecommons.org/publicdomain/mark/1.0/deed.en) downloaded from [PDOK](https://www.nationaalgeoregister.nl/geonetwork/srv/dut/catalog.search#/metadata/e01e63cd-6b3d-4c58-b34e-8d343a3c264b)

data/examples/pytest_osm_graph.pkl.license

@@ -0,0 +1,3 @@
+SPDX-FileCopyrightText: Contributors to the utility-route-project and Alliander N.V.
+
+SPDX-License-Identifier: Apache-2.0

main.py

@@ -1,13 +1,13 @@
 # SPDX-FileCopyrightText: Contributors to the utility-route-project and Alliander N.V.
 #
 # SPDX-License-Identifier: Apache-2.0
-
 import pathlib
 import time
 
 import shapely
 import structlog
 
+from utility_route_planner.models.benchmark_routes import BenchmarkRouteCollection
 from utility_route_planner.models.lcpa.lcpa_engine import LcpaUtilityRouteEngine
 from settings import Config
 from utility_route_planner.models.mcda.mcda_engine import McdaCostSurfaceEngine
@@ -27,6 +27,7 @@ def run_mcda_lcpa(
     human_designed_route: shapely.LineString,
     raster_name_prefix: str,
     compute_rasters_in_parallel: bool,
+    compute_metrics: bool = True,
 ):
     reset_geopackage(Config.PATH_GEOPACKAGE_MCDA_OUTPUT, truncate=False)
 
@@ -49,71 +50,43 @@ def run_mcda_lcpa(
     )
 
     logger.info(f"Route CPU time: {(time.process_time_ns() - start_cpu_time) / 1e9:.2f} seconds.")
-    route_evaluation_metrics = RouteEvaluationMetrics(
-        lcpa_engine.lcpa_result,
-        path_suitability_raster,
-        human_designed_route,
-        project_area_geometry,
-        mcda_engine.processed_vector_metrics,
-    )
-    route_evaluation_metrics.get_route_evaluation_metrics()
+    if compute_metrics:
+        route_evaluation_metrics = RouteEvaluationMetrics(
+            lcpa_engine.lcpa_result,
+            path_suitability_raster,
+            human_designed_route,
+            project_area_geometry,
+            mcda_engine.processed_vector_metrics,
+        )
+        route_evaluation_metrics.get_route_evaluation_metrics()
 
 
 if __name__ == "__main__":
-    cases = [
-        (
-            Config.PATH_GEOPACKAGE_CASE_01,
-            Config.LAYER_NAME_PROJECT_AREA_CASE_01,
-            Config.LAYER_NAME_HUMAN_DESIGNED_ROUTE_CASE_01,
-            "route_1_",
-            [],
-        ),
-        (
-            Config.PATH_GEOPACKAGE_CASE_02,
-            Config.LAYER_NAME_PROJECT_AREA_CASE_02,
-            Config.LAYER_NAME_HUMAN_DESIGNED_ROUTE_CASE_02,
-            "route_2_",
-            [],
-        ),
-        (
-            Config.PATH_GEOPACKAGE_CASE_03,
-            Config.LAYER_NAME_PROJECT_AREA_CASE_03,
-            Config.LAYER_NAME_HUMAN_DESIGNED_ROUTE_CASE_03,
-            "route_3_",
-            [],
-        ),
-        (
-            Config.PATH_GEOPACKAGE_CASE_04,
-            Config.LAYER_NAME_PROJECT_AREA_CASE_04,
-            Config.LAYER_NAME_HUMAN_DESIGNED_ROUTE_CASE_04,
-            "route_4_",
-            [],
-        ),
-        (
-            Config.PATH_GEOPACKAGE_CASE_05,
-            Config.LAYER_NAME_PROJECT_AREA_CASE_05,
-            Config.LAYER_NAME_HUMAN_DESIGNED_ROUTE_CASE_05,
-            "route_5_",
-            [[121462.8, 487153.4]],
-        ),
-    ]
-
     reset_geopackage(Config.PATH_GEOPACKAGE_LCPA_OUTPUT, truncate=True)
+    route_collection = BenchmarkRouteCollection()
 
-    cases_to_run = [0, 1, 2, 3, 4]  # 0/1/2/3/4
-    for case in cases_to_run:
-        geopackage, layer_project_area, human_designed_route_name, raster_name_prefix, stops = cases[case]
-        human_designed_route = gpd.read_file(geopackage, layer=human_designed_route_name).iloc[0].geometry
+    cases_to_run = [1, 2, 3, 4, 5]
+    for case_id in cases_to_run:
+        benchmark_route = route_collection.get_case(case_id)
+        human_designed_route = (
+            gpd.read_file(benchmark_route.path_geopackage, layer=benchmark_route.layer_name_human_designed_route)
+            .iloc[0]
+            .geometry
+        )
         route_stops = get_first_last_point_from_linestring(human_designed_route)
-        if stops:
-            route_stops = list(route_stops)[:1] + [shapely.Point(i) for i in stops] + list(route_stops)[1:]  # type: ignore
+        if benchmark_route.stops:
+            route_stops = (
+                list(route_stops)[:1] + [shapely.Point(i) for i in benchmark_route.stops] + list(route_stops)[1:]  # type: ignore
+            )
 
         run_mcda_lcpa(
             "preset_benchmark_raw",
-            geopackage,
-            gpd.read_file(geopackage, layer=layer_project_area).iloc[0].geometry,
+            benchmark_route.path_geopackage,
+            gpd.read_file(benchmark_route.path_geopackage, layer=benchmark_route.layer_name_project_area)
+            .iloc[0]
+            .geometry,
             route_stops,
             human_designed_route,
-            raster_name_prefix,
+            benchmark_route.raster_name_prefix,
             compute_rasters_in_parallel=True,
         )

multilayer_main.py

@@ -0,0 +1,109 @@
+# SPDX-FileCopyrightText: Contributors to the utility-route-project and Alliander N.V.
+#
+# SPDX-License-Identifier: Apache-2.0
+import pathlib
+
+import shapely
+import geopandas as gpd
+import time
+
+import structlog
+import typer
+from structlog.contextvars import bound_contextvars
+
+from settings import Config
+from utility_route_planner.models.benchmark_routes import BenchmarkRouteCollection
+from utility_route_planner.models.mcda.mcda_engine import McdaCostSurfaceEngine
+from utility_route_planner.models.multilayer_network.hexagon_graph.hexagon_edge_generator import HexagonEdgeGenerator
+from utility_route_planner.models.multilayer_network.hexagon_graph.hexagon_graph_builder import HexagonGraphBuilder
+from utility_route_planner.models.multilayer_network.hexagon_graph.hexagon_grid_builder import HexagonGridBuilder
+from utility_route_planner.models.multilayer_network.multilayer_route_planner import MultilayerRouteEngine
+from utility_route_planner.models.multilayer_network.osm_graph_downloader import OSMGraphDownloader
+from utility_route_planner.models.multilayer_network.osm_graph_preprocessing import OSMGraphPreprocessor
+from utility_route_planner.models.multilayer_network.pipe_ramming import GetPotentialPipeRammingCrossings
+from utility_route_planner.util.write import reset_geopackage
+
+logger = structlog.get_logger(__name__)
+app = typer.Typer(pretty_exceptions_enable=False)
+
+
+def run_multilayer_network(
+    preset: str,
+    path_geopackage_mcda_input: pathlib.Path,
+    start_mid_end_points: shapely.LineString,
+    project_area_geometry: shapely.Polygon,
+    write_output: bool,
+):
+    reset_geopackage(Config.PATH_GEOPACKAGE_MULTILAYER_NETWORK_OUTPUT, truncate=False)
+    reset_geopackage(Config.PATH_GEOPACKAGE_MCDA_OUTPUT, truncate=False)
+
+    start_cpu_time = time.process_time_ns()
+
+    raw_graph = OSMGraphDownloader(project_area_geometry).download_graph()
+    osm_graph_preprocessed = OSMGraphPreprocessor(raw_graph).preprocess_graph()
+
+    mcda_engine = McdaCostSurfaceEngine(preset, path_geopackage_mcda_input, project_area_geometry)
+    mcda_engine.preprocess_vectors()
+
+    raster_groups = {
+        criteria_key: criteria.group for criteria_key, criteria in mcda_engine.raster_preset.criteria.items()
+    }
+    grid_constructor = HexagonGridBuilder(hexagon_size=Config.HEXAGON_SIZE, block_size=Config.HEXAGON_BLOCK_SIZE)
+    hexagon_edge_generator = HexagonEdgeGenerator()
+    hexagon_graph_builder = HexagonGraphBuilder(grid_builder=grid_constructor, edge_generator=hexagon_edge_generator)
+    cost_surface_graph, cost_surface_nodes = hexagon_graph_builder.build_graph(
+        mcda_engine.project_area_geometry,
+        raster_groups,
+        mcda_engine.processed_vectors,
+    )
+    pipe_ramming = GetPotentialPipeRammingCrossings(osm_graph_preprocessed, cost_surface_graph, cost_surface_nodes)
+    pipe_ramming.get_crossings()
+
+    multi_layer_route_engine = MultilayerRouteEngine(
+        pipe_ramming.cost_surface_graph,
+        pipe_ramming.osm_graph,
+        pipe_ramming.cost_surface_nodes,
+        Config.HEXAGON_SIZE,
+        prefix="testing_",
+        write_output=write_output,
+    )
+    multi_layer_route_engine.find_route(start_mid_end_points)
+
+    logger.info(f"Multilayer route CPU time: {(time.process_time_ns() - start_cpu_time) / 1e9:.2f} seconds.")
+
+
+@app.command()
+def run_debug_case(write_routing_output: bool = False):
+    with bound_contextvars(project_area="Componistenbuurt"):
+        logger.info("Running multilayer routing engine for debug project area")
+        run_multilayer_network(
+            Config.RASTER_PRESET_NAME_BENCHMARK,
+            Config.PYTEST_PATH_GEOPACKAGE_MCDA,
+            shapely.LineString([(174847.18, 451178.43), (175746.347, 450435.534)]),
+            gpd.read_file(Config.PYTEST_PATH_GEOPACKAGE_MCDA, layer=Config.PYTEST_LAYER_NAME_PROJECT_AREA)
+            .iloc[0]
+            .geometry,
+            write_routing_output,
+        )
+
+
+@app.command()
+def run_benchmark_case(benchmark_case_id: int, write_routing_output: bool = False):
+    benchmark_routes = BenchmarkRouteCollection()
+    with bound_contextvars(benchmark_id=benchmark_case_id):
+        benchmark_route = benchmark_routes.get_case(benchmark_case_id)
+        run_multilayer_network(
+            Config.RASTER_PRESET_NAME_BENCHMARK,
+            benchmark_route.path_geopackage,
+            gpd.read_file(benchmark_route.path_geopackage, layer=benchmark_route.layer_name_human_designed_route)
+            .iloc[0]
+            .geometry,
+            gpd.read_file(benchmark_route.path_geopackage, layer=benchmark_route.layer_name_project_area)
+            .iloc[0]
+            .geometry,
+            write_routing_output,
+        )
+
+
+if __name__ == "__main__":
+    app()