r5py 1.0.3.dev0__py3-none-any.whl → 1.0.5__py3-none-any.whl

r5py/__init__.py

@@ -2,12 +2,13 @@
 
 """Python wrapper for the R5 routing analysis engine."""
 
-__version__ = "1.0.3.dev0"
+__version__ = "1.0.5"
 
 
 from .r5 import (
     DetailedItineraries,
     DetailedItinerariesComputer,
+    ElevationCostFunction,
     Isochrones,
     RegionalTask,
     TransportMode,
@@ -19,6 +20,7 @@ from .r5 import (
 __all__ = [
     "DetailedItineraries",
     "DetailedItinerariesComputer",
+    "ElevationCostFunction",
     "Isochrones",
     "RegionalTask",
     "TransportMode",

r5py/r5/__init__.py

@@ -6,6 +6,7 @@ from .access_leg import AccessLeg
 from .detailed_itineraries import DetailedItineraries, DetailedItinerariesComputer
 from .direct_leg import DirectLeg
 from .egress_leg import EgressLeg
+from .elevation_cost_function import ElevationCostFunction
 from .isochrones import Isochrones
 from .regional_task import RegionalTask
 from .scenario import Scenario
@@ -24,6 +25,7 @@ __all__ = [
     "DetailedItinerariesComputer",
     "DirectLeg",
     "EgressLeg",
+    "ElevationCostFunction",
     "Isochrones",
     "RegionalTask",
     "Scenario",

r5py/r5/elevation_cost_function.py

@@ -0,0 +1,50 @@
+#!/usr/bin/env python3
+
+
+"""The elevation cost functions supported by R5 (Tobler, Minetti)."""
+
+
+import enum
+
+import jpype
+
+from ..util import start_jvm
+
+import com.conveyal.r5
+
+
+__all__ = ["ElevationCostFunction"]
+
+
+start_jvm()
+
+
+class ElevationCostFunction(enum.Enum):
+    """
+    Elevation cost functions.
+
+    TOBLER: Waldo Tobler’s hiking function, cf. https://en.wikipedia.org/wiki/Tobler%27s_hiking_function
+    MINETTI: Minetti et al.’s perceived effort/energy consumption, cf.
+    https://doi.org/10.1152/japplphysiol.01177.2001
+    """
+
+    @classmethod
+    def _missing_(cls, value):
+        value = str(value).upper()
+        for member in cls:
+            if value == member.value:
+                return member
+        return None
+
+    TOBLER = "TOBLER"
+    MINETTI = "MINETTI"
+
+
+@jpype._jcustomizer.JConversion(
+    "com.conveyal.r5.analyst.scenario.RasterCost.CostFunction",
+    exact=ElevationCostFunction,
+)
+def _cast_LegMode(java_class, object_):
+    return com.conveyal.r5.analyst.scenario.RasterCost.CostFunction.valueOf(
+        object_.name
+    )

r5py/r5/elevation_model.py

@@ -0,0 +1,84 @@
+#!/usr/bin/env python3
+
+
+"""Load a digital elevation model and apply it to an r5py.TransportNetwork."""
+
+
+import rasterio
+
+from .elevation_cost_function import ElevationCostFunction
+from .file_storage import FileStorage
+from ..util import WorkingCopy
+
+import com.conveyal.analysis
+import com.conveyal.r5
+
+
+__all__ = ["ElevationModel"]
+
+
+class ElevationModel:
+    """Load a digital elevation model and apply it to an r5py.TransportNetwork."""
+
+    def __init__(
+        self,
+        elevation_model,
+        elevation_cost_function=ElevationCostFunction.TOBLER,
+    ):
+        """
+        Load an elevation model.
+
+        Arguments
+        ---------
+        elevation_model : str | pathlib.Path
+            file path to a digital elevation model in TIF format,
+            single-band, the value of which is the elevation in metres
+        elevation_cost_function : r5py.ElevationCostFunction
+            which algorithm to use to compute the added effort and travel time
+            of slopes
+        """
+        elevation_model = WorkingCopy(elevation_model)
+        elevation_model = self._convert_tiff_to_format_readable_by_r5(elevation_model)
+
+        # instantiate an com.conveyal.file.FileStorage singleton
+        com.conveyal.analysis.components.WorkerComponents.fileStorage = FileStorage()
+
+        self._elevation_model = com.conveyal.r5.analyst.scenario.RasterCost()
+        self._elevation_model.dataSourceId = f"{elevation_model.with_suffix('')}"
+        self._elevation_model.costFunction = elevation_cost_function
+
+    def apply_to(self, transport_network):
+        """
+        Add the costs associated with elevation traversal to a transport network.
+
+        Arguments
+        ---------
+        transport_network : r5py.TransportNetwork
+            The transport network to which to add slope costs
+        """
+        self._elevation_model.resolve(transport_network)
+        self._elevation_model.apply(transport_network)
+
+    @staticmethod
+    def _convert_tiff_to_format_readable_by_r5(tiff):
+        # javax.imagio does not allow all compression/predictor
+        # combinations of TIFFs
+        # to work around it, convert the input to a format known to work.
+
+        input_tiff = tiff.with_stem(f".{tiff.stem}")
+        output_tiff = tiff.with_suffix(".tif")
+        tiff.rename(input_tiff)
+
+        with rasterio.open(input_tiff) as source:
+            metadata = source.profile
+            metadata.update(
+                {
+                    "compress": "LZW",
+                    "predictor": "2",
+                }
+            )
+            with rasterio.open(output_tiff, "w", **metadata) as destination:
+                destination.write(source.read())
+        input_tiff.unlink()
+
+        return output_tiff

r5py/r5/file_storage.py

@@ -0,0 +1,84 @@
+#!/usr/bin/env python3
+
+
+"""A thin layer around com.conveyal.r5.file.FileStorage."""
+
+
+import jpype
+
+from ..util import start_jvm
+
+import com.conveyal.file
+import java.io.File
+
+
+__all__ = ["FileStorage"]
+
+
+start_jvm()
+
+
+@jpype.JImplements(com.conveyal.file.FileStorage)
+class FileStorage:
+    """A thin layer around com.conveyal.r5.file.FileStorage."""
+
+    @jpype.JOverride
+    def moveIntoStorage(self, *args):
+        """Not implemented."""
+        pass
+
+    @jpype.JOverride
+    def getFile(self, file_storage_key):
+        """
+        Return a java.io.File for the file identified by file_storage_key.
+
+        Arguments
+        ---------
+        file_storage_key : com.conveyal.r5.file.FileStorageKey
+            An R5 object referencing a certain file
+
+        Returns
+        -------
+        java.io.File
+            The file identified by file_storage_key
+        """
+        return java.io.File(file_storage_key.path)
+
+    @jpype.JOverride
+    def getURL(self, file_storage_key):
+        """
+        Return an URL for the file identified by file_storage_key.
+
+        Arguments
+        ---------
+        file_storage_key : com.conveyal.r5.file.FileStorageKey
+            An R5 object referencing a certain file
+
+        Returns
+        -------
+        str
+            An imaginary URL pointing to the file identified by file_storage_key
+        """
+        return f"file://{file_storage_key.path}"
+
+    @jpype.JOverride
+    def delete(self, *args):
+        """Not implemented."""
+        pass
+
+    @jpype.JOverride
+    def exists(self, file_storage_key):
+        """
+        Check whether the file identified by file_storage_key exists.
+
+        Arguments
+        ---------
+        file_storage_key : com.conveyal.r5.file.FileStorageKey
+            An R5 object referencing a certain file
+
+        Returns
+        -------
+        bool
+            Whether or not the file identified by file_storage_key exists
+        """
+        return self.getFile(file_storage_key).exists()

r5py/r5/transport_network.py

@@ -12,12 +12,15 @@ import warnings
 import jpype
 import jpype.types
 
+from .elevation_cost_function import ElevationCostFunction
+from .elevation_model import ElevationModel
 from .street_layer import StreetLayer
 from .transit_layer import TransitLayer
 from .transport_mode import TransportMode
 from ..util import Config, contains_gtfs_data, FileDigest, start_jvm, WorkingCopy
 from ..util.exceptions import GtfsFileError
 
+import com.conveyal.analysis
 import com.conveyal.gtfs
 import com.conveyal.osmlib
 import com.conveyal.r5
@@ -36,7 +39,14 @@ start_jvm()
 class TransportNetwork:
     """Wrap a com.conveyal.r5.transit.TransportNetwork."""
 
-    def __init__(self, osm_pbf, gtfs=[], allow_errors=False):
+    def __init__(
+        self,
+        osm_pbf,
+        gtfs=[],
+        elevation_model=None,
+        elevation_cost_function=ElevationCostFunction.TOBLER,
+        allow_errors=False,
+    ):
         """
         Load a transport network.
 
@@ -46,6 +56,12 @@ class TransportNetwork:
             file path of an OpenStreetMap extract in PBF format
         gtfs : str | pathlib.Path | list[str] | list[pathlib.Path]
             path(s) to public transport schedule information in GTFS format
+        elevation_model : str | pathlib.Path
+            file path to a digital elevation model in TIF format,
+            single-band, the value of which is the elevation in metres
+        elevation_cost_function : r5py.ElevationCostFunction
+            which algorithm to use to compute the added effort and travel time
+            of slopes
         allow_errors : bool
             try to proceed with loading the transport network even if input data
             contain errors
@@ -57,16 +73,18 @@ class TransportNetwork:
 
         # a hash representing all input files
         digest = hashlib.sha256(
-            "".join([FileDigest(osm_pbf)] + [FileDigest(path) for path in gtfs]).encode(
-                "utf-8"
-            )
+            "".join(
+                [FileDigest(osm_pbf)]
+                + [FileDigest(path) for path in gtfs]
+                + [FileDigest(elevation_model) if elevation_model is not None else ""]
+            ).encode("utf-8")
         ).hexdigest()
 
         try:
             transport_network = self._load_pickled_transport_network(
                 Config().CACHE_DIR / f"{digest}.transport_network"
             )
-        except FileNotFoundError:
+        except (FileNotFoundError, java.io.IOError, java.lang.RuntimeException):
             transport_network = com.conveyal.r5.transit.TransportNetwork()
             transport_network.scenarioId = PACKAGE
 
@@ -122,6 +140,12 @@ class TransportNetwork:
 
             transport_network.transitLayer.buildDistanceTables(None)
 
+            if elevation_model is not None:
+                ElevationModel(
+                    elevation_model,
+                    elevation_cost_function,
+                ).apply_to(transport_network)
+
             osm_file.close()  # not needed after here?
 
             self._save_pickled_transport_network(

r5py/util/classpath.py

@@ -18,9 +18,9 @@ from .warnings import R5pyWarning
 
 # update these to use a newer R5 version if no R5 available locally
 R5_JAR_URL = (
-    "https://github.com/r5py/r5/releases/download/v7.3-r5py/r5-v7.3-r5py-all.jar"
+    "https://github.com/r5py/r5/releases/download/v7.4-r5py/r5-v7.4-r5py-all.jar"
 )
-R5_JAR_SHA256 = "cb1ccad370757ba229cf17f1bedc9549ff5d77fdbb44b7a3058104fe1f243f53"
+R5_JAR_SHA256 = "c51b566671165d113add84e10e60fb9273014ca4a2e2a52591446954f68e7340"
 # ---
 
 

r5py/util/config.py

@@ -92,7 +92,13 @@ class Config:
                 FileNotFoundError,  # broken symlink
                 PermissionError,
             ):
-                cached_file.unlink()
+                try:
+                    cached_file.unlink()
+                except (
+                    IsADirectoryError,  # only available on Linux kernels
+                    PermissionError,  # what’s raised instead on Win and MacOs
+                ):
+                    pass
 
         return cache_dir
 

r5py/util/jvm.py

@@ -48,6 +48,7 @@ def start_jvm():
 
         jpype.startJVM(
             f"-Xmx{MAX_JVM_MEMORY:d}",
+            "-XX:+RestoreMXCSROnJNICalls",  # https://github.com/r5py/r5py/issues/485
             "-Xcheck:jni",
             "-Xrs",  # https://stackoverflow.com/q/34951812
             "-Duser.language=en",  # Set a default locale, …

{r5py-1.0.3.dev0.dist-info → r5py-1.0.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: r5py
-Version: 1.0.3.dev0
+Version: 1.0.5
 Summary: Python wrapper for the R5 routing analysis engine
 Author: Christoph Fink, Willem Klumpenhouwer, Marcus Sairava, Rafael Pereira, Henrikki Tenkanen
 License: GPL-3.0-or-later or MIT
@@ -26,6 +26,7 @@ Requires-Dist: numpy
 Requires-Dist: pandas>=2.1.0
 Requires-Dist: psutil
 Requires-Dist: pyproj
+Requires-Dist: rasterio
 Requires-Dist: requests
 Requires-Dist: scikit-learn
 Requires-Dist: shapely>=2.0
@@ -55,7 +56,7 @@ Requires-Dist: pyarrow; extra == "tests"
 Requires-Dist: pytest; extra == "tests"
 Requires-Dist: pytest-cov; extra == "tests"
 Requires-Dist: pytest-lazy-fixtures; extra == "tests"
-Requires-Dist: r5py.sampledata.helsinki>=0.1.1; extra == "tests"
+Requires-Dist: r5py.sampledata.helsinki>=1.0.3; extra == "tests"
 Requires-Dist: r5py.sampledata.sao_paulo>=0.1.1; extra == "tests"
 Requires-Dist: typing-extensions; extra == "tests"
 Dynamic: license-file

{r5py-1.0.3.dev0.dist-info → r5py-1.0.5.dist-info}/RECORD

@@ -1,11 +1,14 @@
-r5py/__init__.py,sha256=fmuPx-uivkG0M6kPpYFSiiAHJKYQ4iWAprWSkeq--xA,551
+r5py/__init__.py,sha256=1tPgrbMj7sfKn-uPq_7YhG9CLEMqAcdreD5ytUNBxXw,602
 r5py/__main__.py,sha256=Wvn0ChD7E-dCSZ8b8k_HhHG0KMOk0qMNFkijGuSH3-0,81
-r5py/r5/__init__.py,sha256=BVEeEVc-uUHLPLYBq1LN4exiQIHDw4YyANxNrprb8jQ,1061
+r5py/r5/__init__.py,sha256=ZvzhfO9jHbBsRon6cLjWg_gJWvC4L0rkJtmH5mIUlIg,1149
 r5py/r5/access_leg.py,sha256=W3GfPEpqmWD1c4xipd6UcVIaBC-yb6srGCZV30E2dPY,293
 r5py/r5/base_travel_time_matrix.py,sha256=Vl82Wkk2iANNy6L3r937yXNnQ9lmMOErGT_-fQnb1Ms,6978
 r5py/r5/detailed_itineraries.py,sha256=Oo8JnF5jM2FsYFR1ma9r4y3evOmU7itDYs5M4vbqrZo,11245
 r5py/r5/direct_leg.py,sha256=T7wX8puhOVIssCpflXthYs-G9OA8pasFbdz9p8k8teg,1054
 r5py/r5/egress_leg.py,sha256=9rsCIcwlZUzoZE6q4imNY3VWpjJepO1IJvheVrlPi90,297
+r5py/r5/elevation_cost_function.py,sha256=NXkwPRKZiotVugXQeOYLIgouQmKNx3juSAUi8GHVBLY,1074
+r5py/r5/elevation_model.py,sha256=tGXNzIlRt5fZvteCZ1XQYNby8RLxjzONzSp8k9q3GHs,2745
+r5py/r5/file_storage.py,sha256=wujo-IQyhJYsN7uxTemxNCKzt-pnL5zZgfyn7dZYaLY,1986
 r5py/r5/isochrones.py,sha256=NNpV3Df4NeLdDksGERkb2Eos33ziMBGEeaWyCKPt5P8,12974
 r5py/r5/regional_task.py,sha256=jpOoskx7Y-j-c4E-56uvJXiiuPYK3w28_FJsoGQLSbE,22062
 r5py/r5/scenario.py,sha256=nUNAlN3cO7E_b4sMpNqdL0FD7WQaQ49iIvh-k8l4YRM,763
@@ -15,22 +18,22 @@ r5py/r5/transfer_leg.py,sha256=_IpzQJAyW4hDPO5V4k-ZjIPd3uyxhHPa4U6_b8UbKt4,311
 r5py/r5/transit_layer.py,sha256=vfbzCpTiIpCevSwCTz7EGeFWB4LDrfba1JAqXYo7WXo,2334
 r5py/r5/transit_leg.py,sha256=R0Qc9YLMEXYu51NIdo7Q0bdmpYIJf5irEDXWrW6pZWE,221
 r5py/r5/transport_mode.py,sha256=zHSqXb0R4oyjTp069CzO69IgoCKt0nmOAwsSy272rGo,3675
-r5py/r5/transport_network.py,sha256=eKq4c4L46k_rpPkO9MxPOWHAZ0ZyPzV27lVouNFHqSk,9055
+r5py/r5/transport_network.py,sha256=BkyrI1ovK3QZMTJ3jt0rlf743z6ZhnkLuOpK3NtP89U,10017
 r5py/r5/travel_time_matrix.py,sha256=Z_ErylB8mMD_eO2BogV3K_OFdYFVCcmIPmcMe7GGRiU,8003
 r5py/r5/trip.py,sha256=AqhlhgYaGRL5jVzV08BhsqgWxe8f4wAb5HMP8HIGwc8,2944
 r5py/r5/trip_leg.py,sha256=9E4vZpBEJCXIVqAXWJvnPloC-upEASKhFnjiuen8i8A,6495
 r5py/r5/trip_planner.py,sha256=QM3kSx-EC1VWtmReMtwxzG0CdbtlRi3-PpLxOAoHGrA,23754
 r5py/util/__init__.py,sha256=3iqzebRt7RE1TMzzuGNzyXca0SBcBx1rHLs8eW3ijo4,940
 r5py/util/camel_to_snake_case.py,sha256=zj5F3PNBvsuS6vqN4USeeo8NI-3hnscGhwun0G95AK0,673
-r5py/util/classpath.py,sha256=b16xL94pDxTpc0vrf68R1nvZHnHqZXGcFJaN36eW3wc,2773
-r5py/util/config.py,sha256=5jz42iUaftgBfJ2HNnktZw5oXIPE2ytl3Nxt2RjjDoM,5267
+r5py/util/classpath.py,sha256=jBLQ9S_PwGB0iEqURYXyFCvGOElKX2Wm3Zcid4Nkv3k,2773
+r5py/util/config.py,sha256=tBu2FeC4MnlF6-GSvmV0RkhhFUcOwwiontW-Y15y2mw,5516
 r5py/util/contains_gtfs_data.py,sha256=ooX4hfVDKK0aqX1MI46jSFZ7dZ6riyXaORrgF6PUFrk,1211
 r5py/util/data_validation.py,sha256=H5Mcp2nS4vu5RKym20mPnGpl-8d0SDchzDRJBrrL6WE,1039
 r5py/util/environment.py,sha256=cbSM8TKTuhbXsTIIB06pMtydBOiqLkitF2Lj2asVTho,1082
 r5py/util/exceptions.py,sha256=i1FyTuas43HnlLUIf3zip0Eie2S0j09EcgB9KnmQoKE,1121
 r5py/util/file_digest.py,sha256=95UbaxbTZLa54j1CupsKria028xZ8f6ueZsTupnjlYE,1061
 r5py/util/good_enough_equidistant_crs.py,sha256=7FX3Ly3qegSV_YRA4OFk49LC29xUyTte1Gc5qOEi_9E,2458
-r5py/util/jvm.py,sha256=NCwoYLDznXydcIRAZl2kzUQA6D6NCvzjVG74pm6ioR0,5027
+r5py/util/jvm.py,sha256=ddLh1GI8dBJE-BAe8ScEvYyCVuU7qPDZK58hn_wICbE,5113
 r5py/util/memory_footprint.py,sha256=p8efCUs4UXRg6P1GrRxVs71m7SpEw2mASoz6PVTRvgQ,4672
 r5py/util/parse_int_date.py,sha256=JmnV8TwdUdUp3kSp2e73ZSxCbRyqv2FmQzNt0I_MsM0,667
 r5py/util/sample_data_set.py,sha256=aqUCx6drWD-WbCauewO4EzgOGnFr35mAZt-YHlqb92k,2463
@@ -39,8 +42,8 @@ r5py/util/spatially_clustered_geodataframe.py,sha256=FxG8V3SSeK-PuCep565p1b3TNcl
 r5py/util/validating_requests_session.py,sha256=sH5FgpS9eGax5DG2qA2GrGuiwgTJgh8tKsZ9OiXKmvk,1807
 r5py/util/warnings.py,sha256=CvxKWKlNO_p3riB4SkNqbU5AGPsaY_3-OzqaBObE3B8,139
 r5py/util/working_copy.py,sha256=sbLbRCi39LtC-0tXxvh2y7ZN2D15chbhleCZXzHAFSc,1432
-r5py-1.0.3.dev0.dist-info/licenses/LICENSE,sha256=VAnuGDX1TPylSN9G2xLa-urDpj_SQwn-qqs068dx4tk,51
-r5py-1.0.3.dev0.dist-info/METADATA,sha256=GnVvhl0wT1TNeqWnslpiwmvpw2fYJl62oUjkfptcsss,9981
-r5py-1.0.3.dev0.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
-r5py-1.0.3.dev0.dist-info/top_level.txt,sha256=fOH1R85dkNDOI7jkg-lIsl5CQIO4fE5X868K9dTqs9U,5
-r5py-1.0.3.dev0.dist-info/RECORD,,
+r5py-1.0.5.dist-info/licenses/LICENSE,sha256=VAnuGDX1TPylSN9G2xLa-urDpj_SQwn-qqs068dx4tk,51
+r5py-1.0.5.dist-info/METADATA,sha256=gZw-LnQXOwdZur7nz04k6u06GjtbAL4Y7kD5MTBx6eo,10000
+r5py-1.0.5.dist-info/WHEEL,sha256=QZxptf4Y1BKFRCEDxD4h2V0mBFQOVFLFEpvxHmIs52A,91
+r5py-1.0.5.dist-info/top_level.txt,sha256=fOH1R85dkNDOI7jkg-lIsl5CQIO4fE5X868K9dTqs9U,5
+r5py-1.0.5.dist-info/RECORD,,

{r5py-1.0.3.dev0.dist-info → r5py-1.0.5.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (78.1.0)
+Generator: setuptools (80.6.0)
 Root-Is-Purelib: true
 Tag: py3-none-any