r5py 0.1.1.dev2__tar.gz → 1.0.0__tar.gz

{r5py-0.1.1.dev2/src/r5py.egg-info → r5py-1.0.0}/PKG-INFO

@@ -1,9 +1,8 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: r5py
-Version: 0.1.1.dev2
+Version: 1.0.0
 Summary: Python wrapper for the R5 routing analysis engine
-Author: Willem Klumpenhouwer, Marcus Sairava, Rafael Pereira, Henrikki Tenkanen
-Author-email: Christoph Fink <christoph.fink@helsinki.fi>
+Author: Christoph Fink, Willem Klumpenhouwer, Marcus Sairava, Rafael Pereira, Henrikki Tenkanen
 License: GPL-3.0-or-later or MIT
 Project-URL: Documentation, https://r5py.readthedocs.org/
 Project-URL: Repository, https://github.com/r5py/r5py.git
@@ -19,9 +18,8 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: ConfigArgParse
 Requires-Dist: filelock
-Requires-Dist: fiona
+Requires-Dist: geohexgrid
 Requires-Dist: geopandas
-Requires-Dist: importlib_resources
 Requires-Dist: joblib
 Requires-Dist: jpype1
 Requires-Dist: numpy
@@ -29,7 +27,9 @@ Requires-Dist: pandas>=2.1.0
 Requires-Dist: psutil
 Requires-Dist: pyproj
 Requires-Dist: requests
+Requires-Dist: scikit-learn
 Requires-Dist: shapely>=2.0
+Requires-Dist: simplification
 Provides-Extra: docs
 Requires-Dist: contextily; extra == "docs"
 Requires-Dist: folium; extra == "docs"
@@ -41,8 +41,8 @@ Requires-Dist: matplotlib; extra == "docs"
 Requires-Dist: myst-nb; extra == "docs"
 Requires-Dist: nbsphinx; extra == "docs"
 Requires-Dist: pybtex-apa7-style; extra == "docs"
-Requires-Dist: r5py.sampledata.helsinki>=0.1.1.dev2; extra == "docs"
-Requires-Dist: r5py.sampledata.sao_paulo>=0.1.1.dev2; extra == "docs"
+Requires-Dist: r5py.sampledata.helsinki>=0.1.1; extra == "docs"
+Requires-Dist: r5py.sampledata.sao_paulo>=0.1.1; extra == "docs"
 Requires-Dist: shapely; extra == "docs"
 Requires-Dist: sphinx; extra == "docs"
 Requires-Dist: sphinx-book-theme; extra == "docs"
@@ -50,12 +50,13 @@ Requires-Dist: sphinx-design; extra == "docs"
 Requires-Dist: sphinxcontrib-bibtex; extra == "docs"
 Requires-Dist: sphinxcontrib-images; extra == "docs"
 Provides-Extra: tests
+Requires-Dist: pyarrow; extra == "tests"
 Requires-Dist: pytest; extra == "tests"
-Requires-Dist: pytest-asyncio; extra == "tests"
 Requires-Dist: pytest-cov; extra == "tests"
-Requires-Dist: pytest-lazy-fixture; extra == "tests"
-Requires-Dist: r5py.sampledata.helsinki>=0.1.1.dev2; extra == "tests"
-Requires-Dist: r5py.sampledata.sao_paulo>=0.1.1.dev2; extra == "tests"
+Requires-Dist: pytest-lazy-fixtures; extra == "tests"
+Requires-Dist: r5py.sampledata.helsinki>=0.1.1; extra == "tests"
+Requires-Dist: r5py.sampledata.sao_paulo>=0.1.1; extra == "tests"
+Requires-Dist: typing-extensions; extra == "tests"
 
 <img class="r5py_logo" align="right" src="https://github.com/r5py/r5py/raw/main/docs/_static/images/r5py_blue.svg" alt="r5py logo" style="width:180px; max-width:30vW;">
 
@@ -155,7 +156,7 @@ your project better.
 <!-- (2) other links -->
 [conda-create-env-from-yml]: https://docs.conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html#creating-an-environment-from-an-environment-yml-file
 [conveyal]: https://www.conveyal.com/
-[env-file]: https://github.com/r5py/r5py/blob/main/ci/r5py_distro.yaml
+[env-file]: https://github.com/r5py/r5py/blob/main/ci/r5py.yaml
 [geopandas]: https://geopandas.org/
 [r5-github]: https://github.com/conveyal/r5/
 [r5r-github]: https://github.com/ipeaGIT/r5r/

{r5py-0.1.1.dev2 → r5py-1.0.0}/README.md

@@ -96,7 +96,7 @@ your project better.
 <!-- (2) other links -->
 [conda-create-env-from-yml]: https://docs.conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html#creating-an-environment-from-an-environment-yml-file
 [conveyal]: https://www.conveyal.com/
-[env-file]: https://github.com/r5py/r5py/blob/main/ci/r5py_distro.yaml
+[env-file]: https://github.com/r5py/r5py/blob/main/ci/r5py.yaml
 [geopandas]: https://geopandas.org/
 [r5-github]: https://github.com/conveyal/r5/
 [r5r-github]: https://github.com/ipeaGIT/r5r/

{r5py-0.1.1.dev2 → r5py-1.0.0}/pyproject.toml

@@ -8,7 +8,7 @@ description = "Python wrapper for the R5 routing analysis engine"
 readme = "README.md"
 
 authors = [
-    { name = "Christoph Fink", email = "christoph.fink@helsinki.fi" },
+    { name = "Christoph Fink" },
     { name = "Willem Klumpenhouwer" },
     { name = "Marcus Sairava" },
     { name = "Rafael Pereira" },
@@ -18,9 +18,8 @@ authors = [
 dependencies = [
     "ConfigArgParse",
     "filelock",
-    "fiona",
+    "geohexgrid",
     "geopandas",
-    "importlib_resources",
     "joblib",
     "jpype1",
     "numpy",
@@ -28,7 +27,9 @@ dependencies = [
     "psutil",
     "pyproj",
     "requests",
-    "shapely>=2.0"
+    "scikit-learn",
+    "shapely>=2.0",
+    "simplification"
 ]
 requires-python = ">=3.9"
 
@@ -46,13 +47,12 @@ dynamic = ["version"]
 [project.optional-dependencies]
 docs = ["contextily", "folium", "GitPython", "h3>=4.0.0b2", "jupyterlab_myst",
         "mapclassify", "matplotlib", "myst-nb", "nbsphinx", "pybtex-apa7-style",
-        "r5py.sampledata.helsinki>=0.1.1.dev2",
-        "r5py.sampledata.sao_paulo>=0.1.1.dev2", "shapely", "sphinx",
-        "sphinx-book-theme", "sphinx-design", "sphinxcontrib-bibtex",
-        "sphinxcontrib-images"]
-tests = ["pytest", "pytest-asyncio", "pytest-cov", "pytest-lazy-fixture",
-        "r5py.sampledata.helsinki>=0.1.1.dev2",
-        "r5py.sampledata.sao_paulo>=0.1.1.dev2"]
+        "r5py.sampledata.helsinki>=0.1.1", "r5py.sampledata.sao_paulo>=0.1.1",
+        "shapely", "sphinx", "sphinx-book-theme", "sphinx-design",
+        "sphinxcontrib-bibtex", "sphinxcontrib-images"]
+tests = ["pyarrow", "pytest", "pytest-cov", "pytest-lazy-fixtures",
+         "r5py.sampledata.helsinki>=0.1.1", "r5py.sampledata.sao_paulo>=0.1.1",
+         "typing-extensions"]
 
 
 [project.urls]
@@ -61,22 +61,27 @@ Repository = "https://github.com/r5py/r5py.git"
 "Change log" = "https://github.com/r5py/r5py/blob/main/CHANGELOG.md"
 "Bug tracker" = "https://github.com/r5py/r5py/issues"
 
-[tool.coverage.run]
-omit = ["tests/*", ".virtualenv/**/*"]
+[tool.coverage.paths]
+equivalent_sources = [
+    "src/r5py/",
+    ".virtualenv/lib/python*/site-packages/r5py/",
+    "/opt/hostedtoolcache/Python/*/x64/lib/python*/site-packages/r5py/",
+    "/Library/Frameworks/Python.framework/Versions/*/lib/python*/site-packages/r5py/",
+    "C:/hostedtoolcache/windows/Python/*/x64/Lib/site-packages/r5py/"
+]
 
 [tool.jupytext.formats]
 "docs/notebooks/" = "ipynb"
 "docs/md/" = "md"
 
 [tool.pytest.ini_options]
-addopts = "-p no:faulthandler --cov --cov-report term-missing --cov-report xml"
+addopts = "-p no:faulthandler --cov=r5py --cov-report term-missing --cov-report xml --import-mode=importlib"
 filterwarnings = [
     "error",
     "ignore:Could not find R5 jar, trying to download it from upstream",
     "ignore:Successfully downloaded r5-"
 ]
 testpaths = ["tests"]
-asyncio_mode = "auto"
 
 [tool.setuptools.dynamic]
 version = {attr = "r5py.__version__"}

{r5py-0.1.1.dev2 → r5py-1.0.0}/src/r5py/__init__.py

@@ -2,21 +2,28 @@
 
 """Python wrapper for the R5 routing analysis engine."""
 
-__version__ = "0.1.1.dev2"
+__version__ = "1.0.0"
+
 
 from .r5 import (
+    DetailedItineraries,
     DetailedItinerariesComputer,
+    Isochrones,
     RegionalTask,
     TransportMode,
     TransportNetwork,
+    TravelTimeMatrix,
     TravelTimeMatrixComputer,
 )
 
 __all__ = [
+    "DetailedItineraries",
     "DetailedItinerariesComputer",
+    "Isochrones",
     "RegionalTask",
     "TransportMode",
     "TransportNetwork",
+    "TravelTimeMatrix",
     "TravelTimeMatrixComputer",
     "__version__",
 ]

r5py-1.0.0/src/r5py/__main__.py

@@ -0,0 +1,3 @@
+#!/usr/bin/env python3
+
+"""Python wrapper for the R5 routing analysis engine."""

r5py-1.0.0/src/r5py/r5/__init__.py

@@ -0,0 +1,42 @@
+#!/usr/bin/env python3
+
+"""R5 classes."""
+
+from .access_leg import AccessLeg
+from .breakdown_stat import BreakdownStat
+from .detailed_itineraries import DetailedItineraries, DetailedItinerariesComputer
+from .direct_leg import DirectLeg
+from .egress_leg import EgressLeg
+from .isochrones import Isochrones
+from .regional_task import RegionalTask
+from .scenario import Scenario
+from .street_layer import StreetLayer
+from .transfer_leg import TransferLeg
+from .transit_leg import TransitLeg
+from .transport_mode import TransportMode
+from .transport_network import TransportNetwork
+from .travel_time_matrix import TravelTimeMatrix, TravelTimeMatrixComputer
+from .trip import Trip
+from .trip_planner import TripPlanner
+
+__all__ = [
+    "AccessLeg",
+    "BreakdownStat",
+    "DetailedItineraries",
+    "DetailedItinerariesComputer",
+    "DirectLeg",
+    "EgressLeg",
+    "Isochrones",
+    "RegionalTask",
+    "Scenario",
+    "SpeedConfig",
+    "StreetLayer",
+    "TransferLeg",
+    "TransitLeg",
+    "TransportMode",
+    "TransportNetwork",
+    "TravelTimeMatrix",
+    "TravelTimeMatrixComputer",
+    "Trip",
+    "TripPlanner",
+]

r5py-0.1.1.dev2/src/r5py/r5/base_travel_time_matrix_computer.py → r5py-1.0.0/src/r5py/r5/base_travel_time_matrix.py

@@ -6,6 +6,7 @@ import math
 import multiprocessing
 import warnings
 
+import geopandas
 import numpy
 import shapely
 
@@ -14,7 +15,7 @@ from .regional_task import RegionalTask
 from .transport_network import TransportNetwork
 
 
-__all__ = ["BaseTravelTimeMatrixComputer"]
+__all__ = ["BaseTravelTimeMatrix"]
 
 
 # R5 fills cut-off (NULL) values with MAX_INT32
@@ -26,13 +27,26 @@ MAX_INT32 = (2**31) - 1
 NUM_THREADS = math.ceil(multiprocessing.cpu_count() * 0.5)
 
 
-class BaseTravelTimeMatrixComputer:
+class BaseTravelTimeMatrix(geopandas.GeoDataFrame):
     """Base class for travel time computers between many origins and destinations."""
 
     MAX_INT32 = MAX_INT32
 
     NUM_THREADS = NUM_THREADS
 
+    _r5py_attributes = [
+        "_destinations",
+        "_destinations_crs",
+        "_origins",
+        "_origins_crs",
+        "destinations",
+        "origins",
+        "request",
+        "snap_to_network",
+        "transport_network",
+        "verbose",
+    ]
+
     def __init__(
         self,
         transport_network,
@@ -71,6 +85,8 @@ class BaseTravelTimeMatrixComputer:
             ``max_time_cycling``, ``max_time_driving``, ``speed_cycling``, ``speed_walking``,
             ``max_public_transport_rides``, ``max_bicycle_traffic_stress``
         """
+        geopandas.GeoDataFrame.__init__(self)
+
         if not isinstance(transport_network, TransportNetwork):
             transport_network = TransportNetwork(*transport_network)
         self.transport_network = transport_network
@@ -89,8 +105,16 @@ class BaseTravelTimeMatrixComputer:
 
         self.verbose = Config().arguments.verbose
 
+    def __setattr__(self, attr, val):
+        """Catch our own attributes here so we don’t mess with (geo)pandas columns."""
+        if attr in self._r5py_attributes:
+            object.__setattr__(self, attr, val)
+        else:
+            super().__setattr__(attr, val)
+
     @property
     def destinations(self):
+        """The destinations of this travel time matrix (`geopandas.GeoDataFrame`)."""
         return self._destinations
 
     @destinations.setter
@@ -120,10 +144,7 @@ class BaseTravelTimeMatrixComputer:
         return data_set.map(lambda x: numpy.nan if x == MAX_INT32 else x)
 
     def _prepare_origins_destinations(self):
-        """
-        Make sure we received enough information to route from origins to
-        destinations.
-        """
+        """Make sure we received enough information to route from origins to destinations."""
         try:
             self.origins
         except AttributeError as exception:
@@ -161,10 +182,9 @@ class BaseTravelTimeMatrixComputer:
 
                 setattr(self, f"_{which_end}", points.copy())
 
-            self.snap_to_network = False  # prevent repeated snapping on same point sets
-
     @property
     def origins(self):
+        """The origins of this travel time matrix (`geopandas.GeoDataFrame`)."""
         return self._origins
 
     @origins.setter

r5py-0.1.1.dev2/src/r5py/r5/detailed_itineraries_computer.py → r5py-1.0.0/src/r5py/r5/detailed_itineraries.py

@@ -7,23 +7,33 @@
 import copy
 import warnings
 
+try:
+    from warnings import deprecated
+except ImportError:  # Python<=3.12
+    from typing_extensions import deprecated
+
 import geopandas
 import joblib
 import pandas
 
-from .base_travel_time_matrix_computer import BaseTravelTimeMatrixComputer
+from .base_travel_time_matrix import BaseTravelTimeMatrix
 from .trip import Trip
 from .trip_planner import ACCURATE_GEOMETRIES, TripPlanner
 
 
-__all__ = ["DetailedItinerariesComputer"]
+__all__ = ["DetailedItineraries", "DetailedItinerariesComputer"]
 
 
-class DetailedItinerariesComputer(BaseTravelTimeMatrixComputer):
+class DetailedItineraries(BaseTravelTimeMatrix):
     """Compute detailed itineraries between many origins and destinations."""
 
     COLUMNS = ["from_id", "to_id", "option"] + Trip.COLUMNS
 
+    _r5py_attributes = BaseTravelTimeMatrix._r5py_attributes + [
+        "all_to_all",
+        "od_pairs",
+    ]
+
     def __init__(
         self,
         transport_network,
@@ -36,6 +46,10 @@ class DetailedItinerariesComputer(BaseTravelTimeMatrixComputer):
         """
         Compute travel times between many origins and destinations.
 
+        ``r5py.DetailedItineraries`` are child classes of
+        ``geopandas.GeoDataFrame`` and support all of their methods and
+        properties, see https://geopandas.org/en/stable/docs.html
+
         Arguments
         ---------
         transport_network : r5py.TransportNetwork | tuple(str, list(str), dict)
@@ -58,10 +72,10 @@ class DetailedItinerariesComputer(BaseTravelTimeMatrixComputer):
             if `int`, use `snap_to_network` meters as the search radius.
         force_all_to_all : bool, default False
             If ``origins`` and ``destinations`` have the same length, by
-            default, ``DetailedItinerariesComputer`` finds routes between pairs
+            default, ``DetailedItineraries`` finds routes between pairs
             of origins and destinations, i.e., it routes from origin #1 to
             destination #1, origin #2 to destination #2, ... .
-            Set ``all_to_all=True`` to route from each origin to all
+            Set ``force_all_to_all=True`` to route from each origin to all
             destinations (this is the default, if ``origins`` and ``destinations``
             have different lengths, or if ``destinations`` is omitted)
         **kwargs : mixed
@@ -70,7 +84,7 @@ class DetailedItinerariesComputer(BaseTravelTimeMatrixComputer):
             ``access_modes``, ``egress_modes``, ``max_time``, ``max_time_walking``,
             ``max_time_cycling``, ``max_time_driving``, ``speed_cycling``, ``speed_walking``,
             ``max_public_transport_rides``, ``max_bicycle_traffic_stress``
-            Not that not all arguments might make sense in this context, and the
+            Note that not all arguments might make sense in this context, and the
             underlying R5 engine might ignore some of them.
         """
         super().__init__(
@@ -106,7 +120,23 @@ class DetailedItinerariesComputer(BaseTravelTimeMatrixComputer):
         else:
             self.all_to_all = force_all_to_all
 
-    def compute_travel_details(self):
+        data = self._compute()
+        with warnings.catch_warnings():
+            warnings.filterwarnings(
+                "ignore",
+                message=(
+                    "You are adding a column named 'geometry' to a GeoDataFrame "
+                    "constructed without an active geometry column"
+                ),
+                category=FutureWarning,
+            )
+            for column in data.columns:
+                self[column] = data[column]
+            self.set_geometry("geometry")
+
+        del self.transport_network
+
+    def _compute(self):
         """
         Compute travel times from all origins to all destinations.
 
@@ -114,17 +144,21 @@ class DetailedItinerariesComputer(BaseTravelTimeMatrixComputer):
         -------
         geopandas.GeoDataFrame
             The resulting detailed routes. For each origin/destination pair,
+            multiple route alternatives (‘options’) might be reported that each
+            consist of one or more segments. Each segment represents one row.
             multiple route alternatives (‘options’) might be reported that each consist of
             one or more segments. Each segment represents one row.
+
             The data frame comprises of the following columns: `from_id`,
             `to_id`, `option` (`int`), `segment` (`int`), `transport_mode`
             (`r5py.TransportMode`), `departure_time` (`datetime.datetime`),
             `distance` (`float`, metres), `travel_time` (`datetime.timedelta`),
-            `wait_time` (`datetime.timedelta`), `route` (`str`, public transport
-            route number or name), `geometry` (`shapely.LineString`)
-            TODO: Add description of output data frame columns and format
+            `wait_time` (`datetime.timedelta`), `feed` (`str`, the feed name
+            used), `agency_id` (`str` the public transport agency identifier),
+            `route_id` (`str`, public transport route ID), `start_stop_id`
+            (`str`, the GTFS stop_id for boarding), `end_stop_id` (`str`, the
+            GTFS stop_id for alighting), `geometry` (`shapely.LineString`)
         """
-
         self._prepare_origins_destinations()
 
         # warn if public transport routes are requested, but R5 has been
@@ -150,11 +184,12 @@ class DetailedItinerariesComputer(BaseTravelTimeMatrixComputer):
             verbose=(10 * self.verbose),  # joblib has a funny verbosity scale
             n_jobs=self.NUM_THREADS,
         ) as parallel:
+            matrices = parallel(
+                joblib.delayed(self._travel_details_per_od_pair)(from_id, to_id)
+                for _, (from_id, to_id) in self.od_pairs.iterrows()
+            )
             od_matrix = pandas.concat(
-                parallel(
-                    joblib.delayed(self._travel_details_per_od_pair)(from_id, to_id)
-                    for _, (from_id, to_id) in self.od_pairs.iterrows()
-                ),
+                [matrix.astype(matrices[0].dtypes) for matrix in matrices],
                 ignore_index=True,
             )
 
@@ -162,11 +197,7 @@ class DetailedItinerariesComputer(BaseTravelTimeMatrixComputer):
         return od_matrix
 
     def _prepare_origins_destinations(self):
-        """
-        Make sure we received enough information to route from origins to
-        destinations.
-        """
-
+        """Make sure we received enough information to route from origins to destinations."""
         super()._prepare_origins_destinations()
 
         if self.all_to_all:
@@ -208,3 +239,34 @@ class DetailedItinerariesComputer(BaseTravelTimeMatrixComputer):
         # fmt: on
 
         return pandas.DataFrame(trips, columns=self.COLUMNS)
+
+
+@deprecated(
+    "Use `DetailedItineraries` instead, `DetailedItinerariesComputer will be deprecated in a future release."
+)
+class DetailedItinerariesComputer:
+    """Compute detailed itineraries between many origins and destinations."""
+
+    def __init__(self, *args, **kwargs):
+        """Compute detailed itineraries between many origins and destinations."""
+        self._detailed_itineraries = DetailedItineraries(*args, **kwargs)
+
+    def compute_travel_details(self):
+        """
+        Compute travel times from all origins to all destinations.
+
+        Returns
+        -------
+        geopandas.GeoDataFrame
+            The resulting detailed routes. For each origin/destination pair,
+            multiple route alternatives (‘options’) might be reported that each consist of
+            one or more segments. Each segment represents one row.
+            The data frame comprises of the following columns: `from_id`,
+            `to_id`, `option` (`int`), `segment` (`int`), `transport_mode`
+            (`r5py.TransportMode`), `departure_time` (`datetime.datetime`),
+            `distance` (`float`, metres), `travel_time` (`datetime.timedelta`),
+            `wait_time` (`datetime.timedelta`), `route` (`str`, public transport
+            route number or name), `geometry` (`shapely.LineString`)
+            TODO: Add description of output data frame columns and format
+        """
+        return self._detailed_itineraries

{r5py-0.1.1.dev2 → r5py-1.0.0}/src/r5py/r5/direct_leg.py

@@ -15,9 +15,7 @@ __all__ = ["DirectLeg"]
 
 
 class DirectLeg(TripLeg):
-    """
-    Represent one leg of a public transport trip.
-    """
+    """Represent one leg of a public transport trip."""
 
     def __init__(self, transport_mode, street_segment):
         """