r5py 1.0.0.dev9__tar.gz → 1.0.0.dev12__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.

This version of r5py might be problematic. Click here for more details.

Files changed (82) hide show
  1. {r5py-1.0.0.dev9 → r5py-1.0.0.dev12}/LICENSE +3 -3
  2. {r5py-1.0.0.dev9/src/r5py.egg-info → r5py-1.0.0.dev12}/PKG-INFO +166 -164
  3. {r5py-1.0.0.dev9 → r5py-1.0.0.dev12}/README.md +106 -106
  4. {r5py-1.0.0.dev9 → r5py-1.0.0.dev12}/pyproject.toml +87 -85
  5. {r5py-1.0.0.dev9 → r5py-1.0.0.dev12}/setup.cfg +4 -4
  6. {r5py-1.0.0.dev9 → r5py-1.0.0.dev12}/src/r5py/__init__.py +29 -27
  7. {r5py-1.0.0.dev9 → r5py-1.0.0.dev12}/src/r5py/__main__.py +3 -3
  8. {r5py-1.0.0.dev9 → r5py-1.0.0.dev12}/src/r5py/r5/__init__.py +42 -40
  9. {r5py-1.0.0.dev9 → r5py-1.0.0.dev12}/src/r5py/r5/access_leg.py +14 -14
  10. {r5py-1.0.0.dev9 → r5py-1.0.0.dev12}/src/r5py/r5/base_travel_time_matrix.py +195 -195
  11. {r5py-1.0.0.dev9 → r5py-1.0.0.dev12}/src/r5py/r5/breakdown_stat.py +26 -26
  12. {r5py-1.0.0.dev9 → r5py-1.0.0.dev12}/src/r5py/r5/detailed_itineraries.py +272 -263
  13. {r5py-1.0.0.dev9 → r5py-1.0.0.dev12}/src/r5py/r5/direct_leg.py +40 -40
  14. {r5py-1.0.0.dev9 → r5py-1.0.0.dev12}/src/r5py/r5/egress_leg.py +14 -14
  15. r5py-1.0.0.dev12/src/r5py/r5/isochrones.py +351 -0
  16. {r5py-1.0.0.dev9 → r5py-1.0.0.dev12}/src/r5py/r5/regional_task.py +581 -581
  17. {r5py-1.0.0.dev9 → r5py-1.0.0.dev12}/src/r5py/r5/scenario.py +37 -37
  18. {r5py-1.0.0.dev9 → r5py-1.0.0.dev12}/src/r5py/r5/street_layer.py +92 -88
  19. r5py-1.0.0.dev12/src/r5py/r5/street_segment.py +41 -0
  20. {r5py-1.0.0.dev9 → r5py-1.0.0.dev12}/src/r5py/r5/transfer_leg.py +14 -14
  21. {r5py-1.0.0.dev9 → r5py-1.0.0.dev12}/src/r5py/r5/transit_layer.py +110 -110
  22. {r5py-1.0.0.dev9 → r5py-1.0.0.dev12}/src/r5py/r5/transit_leg.py +14 -14
  23. {r5py-1.0.0.dev9 → r5py-1.0.0.dev12}/src/r5py/r5/transport_mode.py +149 -149
  24. r5py-1.0.0.dev12/src/r5py/r5/transport_network.py +236 -0
  25. {r5py-1.0.0.dev9 → r5py-1.0.0.dev12}/src/r5py/r5/travel_time_matrix.py +209 -208
  26. {r5py-1.0.0.dev9 → r5py-1.0.0.dev12}/src/r5py/r5/trip.py +99 -99
  27. {r5py-1.0.0.dev9 → r5py-1.0.0.dev12}/src/r5py/r5/trip_leg.py +205 -205
  28. {r5py-1.0.0.dev9 → r5py-1.0.0.dev12}/src/r5py/r5/trip_planner.py +586 -587
  29. {r5py-1.0.0.dev9 → r5py-1.0.0.dev12}/src/r5py/util/__init__.py +31 -25
  30. {r5py-1.0.0.dev9 → r5py-1.0.0.dev12}/src/r5py/util/camel_to_snake_case.py +27 -27
  31. {r5py-1.0.0.dev9 → r5py-1.0.0.dev12}/src/r5py/util/classpath.py +93 -93
  32. {r5py-1.0.0.dev9 → r5py-1.0.0.dev12}/src/r5py/util/config.py +171 -155
  33. {r5py-1.0.0.dev9 → r5py-1.0.0.dev12}/src/r5py/util/contains_gtfs_data.py +48 -48
  34. {r5py-1.0.0.dev9 → r5py-1.0.0.dev12}/src/r5py/util/data_validation.py +30 -30
  35. {r5py-1.0.0.dev9 → r5py-1.0.0.dev12}/src/r5py/util/environment.py +34 -34
  36. {r5py-1.0.0.dev9 → r5py-1.0.0.dev12}/src/r5py/util/exceptions.py +40 -40
  37. r5py-1.0.0.dev12/src/r5py/util/file_digest.py +42 -0
  38. {r5py-1.0.0.dev9 → r5py-1.0.0.dev12}/src/r5py/util/good_enough_equidistant_crs.py +75 -70
  39. {r5py-1.0.0.dev9 → r5py-1.0.0.dev12}/src/r5py/util/jvm.py +137 -137
  40. {r5py-1.0.0.dev9 → r5py-1.0.0.dev12}/src/r5py/util/memory_footprint.py +178 -178
  41. {r5py-1.0.0.dev9 → r5py-1.0.0.dev12}/src/r5py/util/parse_int_date.py +26 -26
  42. {r5py-1.0.0.dev9 → r5py-1.0.0.dev12}/src/r5py/util/sample_data_set.py +77 -77
  43. {r5py-1.0.0.dev9 → r5py-1.0.0.dev12}/src/r5py/util/snake_to_camel_case.py +17 -17
  44. r5py-1.0.0.dev12/src/r5py/util/spatially_clustered_geodataframe.py +78 -0
  45. {r5py-1.0.0.dev9 → r5py-1.0.0.dev12}/src/r5py/util/validating_requests_session.py +58 -58
  46. {r5py-1.0.0.dev9 → r5py-1.0.0.dev12}/src/r5py/util/warnings.py +7 -7
  47. r5py-1.0.0.dev12/src/r5py/util/working_copy.py +44 -0
  48. {r5py-1.0.0.dev9 → r5py-1.0.0.dev12/src/r5py.egg-info}/PKG-INFO +166 -164
  49. {r5py-1.0.0.dev9 → r5py-1.0.0.dev12}/src/r5py.egg-info/SOURCES.txt +9 -1
  50. {r5py-1.0.0.dev9 → r5py-1.0.0.dev12}/src/r5py.egg-info/requires.txt +3 -1
  51. {r5py-1.0.0.dev9 → r5py-1.0.0.dev12}/tests/test_breakdownstats.py +30 -30
  52. {r5py-1.0.0.dev9 → r5py-1.0.0.dev12}/tests/test_camel_to_snake_case.py +20 -20
  53. {r5py-1.0.0.dev9 → r5py-1.0.0.dev12}/tests/test_classpath.py +123 -123
  54. r5py-1.0.0.dev12/tests/test_config.py +48 -0
  55. {r5py-1.0.0.dev9 → r5py-1.0.0.dev12}/tests/test_contains_gtfs_data.py +22 -22
  56. {r5py-1.0.0.dev9 → r5py-1.0.0.dev12}/tests/test_data_validation.py +73 -73
  57. {r5py-1.0.0.dev9 → r5py-1.0.0.dev12}/tests/test_detailed_itineraries.py +650 -575
  58. {r5py-1.0.0.dev9 → r5py-1.0.0.dev12}/tests/test_deterministic_behaviour.py +71 -70
  59. r5py-1.0.0.dev12/tests/test_file_digest.py +65 -0
  60. {r5py-1.0.0.dev9 → r5py-1.0.0.dev12}/tests/test_good_enough_equidistant_crs.py +105 -105
  61. r5py-1.0.0.dev12/tests/test_isochrones.py +237 -0
  62. {r5py-1.0.0.dev9 → r5py-1.0.0.dev12}/tests/test_java_casting.py +54 -54
  63. {r5py-1.0.0.dev9 → r5py-1.0.0.dev12}/tests/test_memory_footprint.py +84 -84
  64. {r5py-1.0.0.dev9 → r5py-1.0.0.dev12}/tests/test_parse_int_date.py +21 -21
  65. {r5py-1.0.0.dev9 → r5py-1.0.0.dev12}/tests/test_regional_task.py +498 -498
  66. {r5py-1.0.0.dev9 → r5py-1.0.0.dev12}/tests/test_sample_data_set.py +54 -54
  67. {r5py-1.0.0.dev9 → r5py-1.0.0.dev12}/tests/test_snake_to_camel_case.py +20 -20
  68. {r5py-1.0.0.dev9 → r5py-1.0.0.dev12}/tests/test_street_layer.py +118 -118
  69. {r5py-1.0.0.dev9 → r5py-1.0.0.dev12}/tests/test_transit_layer.py +18 -18
  70. {r5py-1.0.0.dev9 → r5py-1.0.0.dev12}/tests/test_transport_mode.py +205 -205
  71. {r5py-1.0.0.dev9 → r5py-1.0.0.dev12}/tests/test_transport_network.py +163 -211
  72. {r5py-1.0.0.dev9 → r5py-1.0.0.dev12}/tests/test_travel_time_matrix.py +586 -586
  73. {r5py-1.0.0.dev9 → r5py-1.0.0.dev12}/tests/test_trip.py +100 -100
  74. {r5py-1.0.0.dev9 → r5py-1.0.0.dev12}/tests/test_trip_leg.py +147 -147
  75. {r5py-1.0.0.dev9 → r5py-1.0.0.dev12}/tests/test_trip_planner.py +13 -13
  76. {r5py-1.0.0.dev9 → r5py-1.0.0.dev12}/tests/test_validating_request_session.py +49 -49
  77. {r5py-1.0.0.dev9 → r5py-1.0.0.dev12}/tests/test_verbose_warnings.py +117 -117
  78. r5py-1.0.0.dev12/tests/test_working_directory.py +39 -0
  79. r5py-1.0.0.dev9/src/r5py/r5/transport_network.py +0 -323
  80. r5py-1.0.0.dev9/tests/test_config.py +0 -27
  81. {r5py-1.0.0.dev9 → r5py-1.0.0.dev12}/src/r5py.egg-info/dependency_links.txt +0 -0
  82. {r5py-1.0.0.dev9 → r5py-1.0.0.dev12}/src/r5py.egg-info/top_level.txt +0 -0
{r5py-1.0.0.dev9 → r5py-1.0.0.dev12}/LICENSE RENAMED
@@ -1,3 +1,3 @@
1
- GPL-3.0-or-later or MIT
2
-
3
- see `licenses/` directory
1
+ GPL-3.0-or-later or MIT
2
+
3
+ see `licenses/` directory
{r5py-1.0.0.dev9/src/r5py.egg-info → r5py-1.0.0.dev12}/PKG-INFO RENAMED
@@ -1,164 +1,166 @@
1
- Metadata-Version: 2.2
2
- Name: r5py
3
- Version: 1.0.0.dev9
4
- Summary: Python wrapper for the R5 routing analysis engine
5
- Author: Christoph Fink, Willem Klumpenhouwer, Marcus Sairava, Rafael Pereira, Henrikki Tenkanen
6
- License: GPL-3.0-or-later or MIT
7
- Project-URL: Documentation, https://r5py.readthedocs.org/
8
- Project-URL: Repository, https://github.com/r5py/r5py.git
9
- Project-URL: Change log, https://github.com/r5py/r5py/blob/main/CHANGELOG.md
10
- Project-URL: Bug tracker, https://github.com/r5py/r5py/issues
11
- Keywords: accessibility,transport,routing,research
12
- Classifier: Programming Language :: Python :: 3
13
- Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
14
- Classifier: License :: OSI Approved :: MIT License
15
- Classifier: Operating System :: OS Independent
16
- Requires-Python: >=3.9
17
- Description-Content-Type: text/markdown
18
- License-File: LICENSE
19
- Requires-Dist: ConfigArgParse
20
- Requires-Dist: filelock
21
- Requires-Dist: fiona
22
- Requires-Dist: geopandas
23
- Requires-Dist: joblib
24
- Requires-Dist: jpype1
25
- Requires-Dist: numpy
26
- Requires-Dist: pandas>=2.1.0
27
- Requires-Dist: psutil
28
- Requires-Dist: pyproj
29
- Requires-Dist: requests
30
- Requires-Dist: shapely>=2.0
31
- Provides-Extra: docs
32
- Requires-Dist: contextily; extra == "docs"
33
- Requires-Dist: folium; extra == "docs"
34
- Requires-Dist: GitPython; extra == "docs"
35
- Requires-Dist: h3>=4.0.0b2; extra == "docs"
36
- Requires-Dist: jupyterlab_myst; extra == "docs"
37
- Requires-Dist: mapclassify; extra == "docs"
38
- Requires-Dist: matplotlib; extra == "docs"
39
- Requires-Dist: myst-nb; extra == "docs"
40
- Requires-Dist: nbsphinx; extra == "docs"
41
- Requires-Dist: pybtex-apa7-style; extra == "docs"
42
- Requires-Dist: r5py.sampledata.helsinki>=0.1.1; extra == "docs"
43
- Requires-Dist: r5py.sampledata.sao_paulo>=0.1.1; extra == "docs"
44
- Requires-Dist: shapely; extra == "docs"
45
- Requires-Dist: sphinx; extra == "docs"
46
- Requires-Dist: sphinx-book-theme; extra == "docs"
47
- Requires-Dist: sphinx-design; extra == "docs"
48
- Requires-Dist: sphinxcontrib-bibtex; extra == "docs"
49
- Requires-Dist: sphinxcontrib-images; extra == "docs"
50
- Provides-Extra: tests
51
- Requires-Dist: pyarrow; extra == "tests"
52
- Requires-Dist: pytest; extra == "tests"
53
- Requires-Dist: pytest-cov; extra == "tests"
54
- Requires-Dist: pytest-lazy-fixtures; extra == "tests"
55
- Requires-Dist: r5py.sampledata.helsinki>=0.1.1; extra == "tests"
56
- Requires-Dist: r5py.sampledata.sao_paulo>=0.1.1; extra == "tests"
57
- Requires-Dist: typing-extensions; extra == "tests"
58
-
59
- <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;">
60
-
61
- # r5py: Rapid Realistic Routing with R5 in Python
62
-
63
- <!-- badges -->
64
- [![Try r5py with binder][binder-badge]][binder-link]
65
- [![DOI][doi-badge]][doi-link]
66
- <br />
67
- [![stable version][stable-version-badge]][stable-version-link]
68
- [![downloads (pypi)][downloads-pypi-badge]][downloads-pypi-link]
69
- [![downloads (conda-forge)][downloads-conda-forge-badge]][downloads-conda-forge-link]
70
- <br />
71
- [![Trunk build status][build-status-badge]][build-status-link]
72
- [![Documentation Status][rtd-status-badge]][rtd-status-link]
73
- [![Coverage][coverage-badge]][coverage-link]
74
- <br />
75
-
76
-
77
- **R5py** is a Python library for rapid realistic routing on multimodal transport
78
- networks (walk, bike, public transport and car). It provides a simple and
79
- friendly interface to R<sup>5</sup>, the Rapid Realistic Routing on Real-world
80
- and Reimagined networks, the [routing engine][r5-github] developed by Conveyal.
81
- **r5py** is inspired by [r5r, a wrapper for R][r5r-vignette], and the library is
82
- designed to interact with [GeoPandas][geopandas] GeoDataFrames.
83
-
84
- **R5py** offers a simple way to run R5 locally with Python. It allows users to
85
- calculate travel time matrices and accessibility by different travel modes. To
86
- get started, see a detailed demonstration of the **r5py** ‘in action’ from the
87
- [Usage][rtd-quickstart] section of its documentation. Over time, **r5py** will
88
- be expanded to incorporate other functionalities from R5.
89
-
90
- ## Installation
91
-
92
- **R5py** is available from conda-forge and PyPi. You can use `mamba`, `pip` or
93
- `conda` to install it. To quickstart your use of **r5py**, we also provide an
94
- [`environment.yml` file ][env-file], using which you can [quickly set up a
95
- development environment][conda-create-env-from-yml] and are ready to go.
96
-
97
- For more details and alternative installation options, read the dedicated
98
- [installation section][rtd-installation] of the r5py documentation.
99
-
100
- ## Usage
101
-
102
- You can find detailed installation instructions, example code, documentation and
103
- API reference at [r5py.readthedocs.io][rtd-link].
104
-
105
-
106
- ## Acknowledgements
107
-
108
- The [R<sup>5</sup> routing engine][r5-github] is developed at
109
- [Conveyal][conveyal] with contributions from several people.
110
-
111
- R5py draws a lot of inspiration from [r5r][r5r-github], an interface to R5 from
112
- the R language that is developed at the Institute for Applied Economic Research
113
- (Ipea), Brazil.
114
-
115
-
116
- ## Citation
117
-
118
- If you use *r5py* for scientific research, please cite it in your publications:
119
-
120
- Fink, C., Klumpenhouwer, W., Saraiva, M., Pereira, R., &amp; Tenkanen, H., 2022:
121
- *r5py: Rapid Realistic Routing with R5 in Python*.
122
- [DOI:10.5281/zenodo.7060437][doi-link]
123
-
124
-
125
- ## License
126
-
127
- This work is dual-licensed under GNU General Public License v3.0 or later and
128
- MIT License. You can choose between the two depending on which license fits
129
- your project better.
130
-
131
- `SPDX-License-Identifier: GPL-3.0-or-later OR MIT`
132
-
133
-
134
- <!-- links used throughout the document -->
135
-
136
- <!-- (1) badges -->
137
- [binder-badge]: https://img.shields.io/badge/Try%20r5py%20with-binder-F5A252.svg?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAFkAAABZCAMAAABi1XidAAAB8lBMVEX///9XmsrmZYH1olJXmsr1olJXmsrmZYH1olJXmsr1olJXmsrmZYH1olL1olJXmsr1olJXmsrmZYH1olL1olJXmsrmZYH1olJXmsr1olL1olJXmsrmZYH1olL1olJXmsrmZYH1olL1olL0nFf1olJXmsrmZYH1olJXmsq8dZb1olJXmsrmZYH1olJXmspXmspXmsr1olL1olJXmsrmZYH1olJXmsr1olL1olJXmsrmZYH1olL1olLeaIVXmsrmZYH1olL1olL1olJXmsrmZYH1olLna31Xmsr1olJXmsr1olJXmsrmZYH1olLqoVr1olJXmsr1olJXmsrmZYH1olL1olKkfaPobXvviGabgadXmsqThKuofKHmZ4Dobnr1olJXmsr1olJXmspXmsr1olJXmsrfZ4TuhWn1olL1olJXmsqBi7X1olJXmspZmslbmMhbmsdemsVfl8ZgmsNim8Jpk8F0m7R4m7F5nLB6jbh7jbiDirOEibOGnKaMhq+PnaCVg6qWg6qegKaff6WhnpKofKGtnomxeZy3noG6dZi+n3vCcpPDcpPGn3bLb4/Mb47UbIrVa4rYoGjdaIbeaIXhoWHmZYHobXvpcHjqdHXreHLroVrsfG/uhGnuh2bwj2Hxk17yl1vzmljzm1j0nlX1olL3AJXWAAAAbXRSTlMAEBAQHx8gICAuLjAwMDw9PUBAQEpQUFBXV1hgYGBkcHBwcXl8gICAgoiIkJCQlJicnJ2goKCmqK+wsLC4usDAwMjP0NDQ1NbW3Nzg4ODi5+3v8PDw8/T09PX29vb39/f5+fr7+/z8/Pz9/v7+zczCxgAABC5JREFUeAHN1ul3k0UUBvCb1CTVpmpaitAGSLSpSuKCLWpbTKNJFGlcSMAFF63iUmRccNG6gLbuxkXU66JAUef/9LSpmXnyLr3T5AO/rzl5zj137p136BISy44fKJXuGN/d19PUfYeO67Znqtf2KH33Id1psXoFdW30sPZ1sMvs2D060AHqws4FHeJojLZqnw53cmfvg+XR8mC0OEjuxrXEkX5ydeVJLVIlV0e10PXk5k7dYeHu7Cj1j+49uKg7uLU61tGLw1lq27ugQYlclHC4bgv7VQ+TAyj5Zc/UjsPvs1sd5cWryWObtvWT2EPa4rtnWW3JkpjggEpbOsPr7F7EyNewtpBIslA7p43HCsnwooXTEc3UmPmCNn5lrqTJxy6nRmcavGZVt/3Da2pD5NHvsOHJCrdc1G2r3DITpU7yic7w/7Rxnjc0kt5GC4djiv2Sz3Fb2iEZg41/ddsFDoyuYrIkmFehz0HR2thPgQqMyQYb2OtB0WxsZ3BeG3+wpRb1vzl2UYBog8FfGhttFKjtAclnZYrRo9ryG9uG/FZQU4AEg8ZE9LjGMzTmqKXPLnlWVnIlQQTvxJf8ip7VgjZjyVPrjw1te5otM7RmP7xm+sK2Gv9I8Gi++BRbEkR9EBw8zRUcKxwp73xkaLiqQb+kGduJTNHG72zcW9LoJgqQxpP3/Tj//c3yB0tqzaml05/+orHLksVO+95kX7/7qgJvnjlrfr2Ggsyx0eoy9uPzN5SPd86aXggOsEKW2Prz7du3VID3/tzs/sSRs2w7ovVHKtjrX2pd7ZMlTxAYfBAL9jiDwfLkq55Tm7ifhMlTGPyCAs7RFRhn47JnlcB9RM5T97ASuZXIcVNuUDIndpDbdsfrqsOppeXl5Y+XVKdjFCTh+zGaVuj0d9zy05PPK3QzBamxdwtTCrzyg/2Rvf2EstUjordGwa/kx9mSJLr8mLLtCW8HHGJc2R5hS219IiF6PnTusOqcMl57gm0Z8kanKMAQg0qSyuZfn7zItsbGyO9QlnxY0eCuD1XL2ys/MsrQhltE7Ug0uFOzufJFE2PxBo/YAx8XPPdDwWN0MrDRYIZF0mSMKCNHgaIVFoBbNoLJ7tEQDKxGF0kcLQimojCZopv0OkNOyWCCg9XMVAi7ARJzQdM2QUh0gmBozjc3Skg6dSBRqDGYSUOu66Zg+I2fNZs/M3/f/Grl/XnyF1Gw3VKCez0PN5IUfFLqvgUN4C0qNqYs5YhPL+aVZYDE4IpUk57oSFnJm4FyCqqOE0jhY2SMyLFoo56zyo6becOS5UVDdj7Vih0zp+tcMhwRpBeLyqtIjlJKAIZSbI8SGSF3k0pA3mR5tHuwPFoa7N7reoq2bqCsAk1HqCu5uvI1n6JuRXI+S1Mco54YmYTwcn6Aeic+kssXi8XpXC4V3t7/ADuTNKaQJdScAAAAAElFTkSuQmCC
138
- [binder-link]: https://notebooks.gesis.org/binder/v2/gh/r5py/r5py/stable?urlpath=tree/docs/user-guide/user-manual/quickstart.md
139
- [build-status-badge]: https://github.com/r5py/r5py/actions/workflows/build-merged-pull-requests.yml/badge.svg
140
- [build-status-link]: https://github.com/r5py/r5py/actions/workflows/build-merged-pull-requests.yml
141
- [coverage-badge]: https://codecov.io/gh/r5py/r5py/branch/main/graph/badge.svg?token=WG8RBMZBK6
142
- [coverage-link]: https://codecov.io/gh/r5py/r5py
143
- [doi-badge]: https://zenodo.org/badge/DOI/10.5281/zenodo.7060437.svg
144
- [doi-link]: https://doi.org/10.5281/zenodo.7060437
145
- [downloads-conda-forge-badge]: https://img.shields.io/conda/dn/conda-forge/r5py?label=Downloads%20%28conda-forge%29
146
- [downloads-conda-forge-link]: https://anaconda.org/conda-forge/r5py
147
- [downloads-pypi-badge]: https://static.pepy.tech/personalized-badge/r5py?period=total&units=international_system&left_color=grey&right_color=orange&left_text=Downloads%20(pypi)
148
- [downloads-pypi-link]: https://pypi.org/project/r5py/
149
- [rtd-status-badge]: https://readthedocs.org/projects/r5py/badge/?version=stable
150
- [rtd-status-link]: https://r5py.readthedocs.io/
151
- [stable-version-badge]: https://img.shields.io/pypi/v/r5py?label=Stable
152
- [stable-version-link]: https://github.com/r5py/r5py/releases
153
-
154
- <!-- (2) other links -->
155
- [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
156
- [conveyal]: https://www.conveyal.com/
157
- [env-file]: https://github.com/r5py/r5py/blob/main/ci/r5py_distro.yaml
158
- [geopandas]: https://geopandas.org/
159
- [r5-github]: https://github.com/conveyal/r5/
160
- [r5r-github]: https://github.com/ipeaGIT/r5r/
161
- [r5r-vignette]: https://ipeagit.github.io/r5r/
162
- [rtd-quickstart]: https://r5py.readthedocs.io/en/stable/user-guide/user-manual/quickstart.html
163
- [rtd-installation]: https://r5py.readthedocs.io/en/stable/user-guide/installation/installation.html
164
- [rtd-link]: https://r5py.readthedocs.io/
1
+ Metadata-Version: 2.2
2
+ Name: r5py
3
+ Version: 1.0.0.dev12
4
+ Summary: Python wrapper for the R5 routing analysis engine
5
+ Author: Christoph Fink, Willem Klumpenhouwer, Marcus Sairava, Rafael Pereira, Henrikki Tenkanen
6
+ License: GPL-3.0-or-later or MIT
7
+ Project-URL: Documentation, https://r5py.readthedocs.org/
8
+ Project-URL: Repository, https://github.com/r5py/r5py.git
9
+ Project-URL: Change log, https://github.com/r5py/r5py/blob/main/CHANGELOG.md
10
+ Project-URL: Bug tracker, https://github.com/r5py/r5py/issues
11
+ Keywords: accessibility,transport,routing,research
12
+ Classifier: Programming Language :: Python :: 3
13
+ Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
14
+ Classifier: License :: OSI Approved :: MIT License
15
+ Classifier: Operating System :: OS Independent
16
+ Requires-Python: >=3.9
17
+ Description-Content-Type: text/markdown
18
+ License-File: LICENSE
19
+ Requires-Dist: ConfigArgParse
20
+ Requires-Dist: filelock
21
+ Requires-Dist: geohexgrid
22
+ Requires-Dist: geopandas
23
+ Requires-Dist: joblib
24
+ Requires-Dist: jpype1
25
+ Requires-Dist: numpy
26
+ Requires-Dist: pandas>=2.1.0
27
+ Requires-Dist: psutil
28
+ Requires-Dist: pyproj
29
+ Requires-Dist: requests
30
+ Requires-Dist: scikit-learn
31
+ Requires-Dist: shapely>=2.0
32
+ Requires-Dist: simplification
33
+ Provides-Extra: docs
34
+ Requires-Dist: contextily; extra == "docs"
35
+ Requires-Dist: folium; extra == "docs"
36
+ Requires-Dist: GitPython; extra == "docs"
37
+ Requires-Dist: h3>=4.0.0b2; extra == "docs"
38
+ Requires-Dist: jupyterlab_myst; extra == "docs"
39
+ Requires-Dist: mapclassify; extra == "docs"
40
+ Requires-Dist: matplotlib; extra == "docs"
41
+ Requires-Dist: myst-nb; extra == "docs"
42
+ Requires-Dist: nbsphinx; extra == "docs"
43
+ Requires-Dist: pybtex-apa7-style; extra == "docs"
44
+ Requires-Dist: r5py.sampledata.helsinki>=0.1.1; extra == "docs"
45
+ Requires-Dist: r5py.sampledata.sao_paulo>=0.1.1; extra == "docs"
46
+ Requires-Dist: shapely; extra == "docs"
47
+ Requires-Dist: sphinx; extra == "docs"
48
+ Requires-Dist: sphinx-book-theme; extra == "docs"
49
+ Requires-Dist: sphinx-design; extra == "docs"
50
+ Requires-Dist: sphinxcontrib-bibtex; extra == "docs"
51
+ Requires-Dist: sphinxcontrib-images; extra == "docs"
52
+ Provides-Extra: tests
53
+ Requires-Dist: pyarrow; extra == "tests"
54
+ Requires-Dist: pytest; extra == "tests"
55
+ Requires-Dist: pytest-cov; extra == "tests"
56
+ Requires-Dist: pytest-lazy-fixtures; extra == "tests"
57
+ Requires-Dist: r5py.sampledata.helsinki>=0.1.1; extra == "tests"
58
+ Requires-Dist: r5py.sampledata.sao_paulo>=0.1.1; extra == "tests"
59
+ Requires-Dist: typing-extensions; extra == "tests"
60
+
61
+ <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;">
62
+
63
+ # r5py: Rapid Realistic Routing with R5 in Python
64
+
65
+ <!-- badges -->
66
+ [![Try r5py with binder][binder-badge]][binder-link]
67
+ [![DOI][doi-badge]][doi-link]
68
+ <br />
69
+ [![stable version][stable-version-badge]][stable-version-link]
70
+ [![downloads (pypi)][downloads-pypi-badge]][downloads-pypi-link]
71
+ [![downloads (conda-forge)][downloads-conda-forge-badge]][downloads-conda-forge-link]
72
+ <br />
73
+ [![Trunk build status][build-status-badge]][build-status-link]
74
+ [![Documentation Status][rtd-status-badge]][rtd-status-link]
75
+ [![Coverage][coverage-badge]][coverage-link]
76
+ <br />
77
+
78
+
79
+ **R5py** is a Python library for rapid realistic routing on multimodal transport
80
+ networks (walk, bike, public transport and car). It provides a simple and
81
+ friendly interface to R<sup>5</sup>, the Rapid Realistic Routing on Real-world
82
+ and Reimagined networks, the [routing engine][r5-github] developed by Conveyal.
83
+ **r5py** is inspired by [r5r, a wrapper for R][r5r-vignette], and the library is
84
+ designed to interact with [GeoPandas][geopandas] GeoDataFrames.
85
+
86
+ **R5py** offers a simple way to run R5 locally with Python. It allows users to
87
+ calculate travel time matrices and accessibility by different travel modes. To
88
+ get started, see a detailed demonstration of the **r5py** ‘in action’ from the
89
+ [Usage][rtd-quickstart] section of its documentation. Over time, **r5py** will
90
+ be expanded to incorporate other functionalities from R5.
91
+
92
+ ## Installation
93
+
94
+ **R5py** is available from conda-forge and PyPi. You can use `mamba`, `pip` or
95
+ `conda` to install it. To quickstart your use of **r5py**, we also provide an
96
+ [`environment.yml` file ][env-file], using which you can [quickly set up a
97
+ development environment][conda-create-env-from-yml] and are ready to go.
98
+
99
+ For more details and alternative installation options, read the dedicated
100
+ [installation section][rtd-installation] of the r5py documentation.
101
+
102
+ ## Usage
103
+
104
+ You can find detailed installation instructions, example code, documentation and
105
+ API reference at [r5py.readthedocs.io][rtd-link].
106
+
107
+
108
+ ## Acknowledgements
109
+
110
+ The [R<sup>5</sup> routing engine][r5-github] is developed at
111
+ [Conveyal][conveyal] with contributions from several people.
112
+
113
+ R5py draws a lot of inspiration from [r5r][r5r-github], an interface to R5 from
114
+ the R language that is developed at the Institute for Applied Economic Research
115
+ (Ipea), Brazil.
116
+
117
+
118
+ ## Citation
119
+
120
+ If you use *r5py* for scientific research, please cite it in your publications:
121
+
122
+ Fink, C., Klumpenhouwer, W., Saraiva, M., Pereira, R., &amp; Tenkanen, H., 2022:
123
+ *r5py: Rapid Realistic Routing with R5 in Python*.
124
+ [DOI:10.5281/zenodo.7060437][doi-link]
125
+
126
+
127
+ ## License
128
+
129
+ This work is dual-licensed under GNU General Public License v3.0 or later and
130
+ MIT License. You can choose between the two depending on which license fits
131
+ your project better.
132
+
133
+ `SPDX-License-Identifier: GPL-3.0-or-later OR MIT`
134
+
135
+
136
+ <!-- links used throughout the document -->
137
+
138
+ <!-- (1) badges -->
139
+ [binder-badge]: https://img.shields.io/badge/Try%20r5py%20with-binder-F5A252.svg?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAFkAAABZCAMAAABi1XidAAAB8lBMVEX///9XmsrmZYH1olJXmsr1olJXmsrmZYH1olJXmsr1olJXmsrmZYH1olL1olJXmsr1olJXmsrmZYH1olL1olJXmsrmZYH1olJXmsr1olL1olJXmsrmZYH1olL1olJXmsrmZYH1olL1olL0nFf1olJXmsrmZYH1olJXmsq8dZb1olJXmsrmZYH1olJXmspXmspXmsr1olL1olJXmsrmZYH1olJXmsr1olL1olJXmsrmZYH1olL1olLeaIVXmsrmZYH1olL1olL1olJXmsrmZYH1olLna31Xmsr1olJXmsr1olJXmsrmZYH1olLqoVr1olJXmsr1olJXmsrmZYH1olL1olKkfaPobXvviGabgadXmsqThKuofKHmZ4Dobnr1olJXmsr1olJXmspXmsr1olJXmsrfZ4TuhWn1olL1olJXmsqBi7X1olJXmspZmslbmMhbmsdemsVfl8ZgmsNim8Jpk8F0m7R4m7F5nLB6jbh7jbiDirOEibOGnKaMhq+PnaCVg6qWg6qegKaff6WhnpKofKGtnomxeZy3noG6dZi+n3vCcpPDcpPGn3bLb4/Mb47UbIrVa4rYoGjdaIbeaIXhoWHmZYHobXvpcHjqdHXreHLroVrsfG/uhGnuh2bwj2Hxk17yl1vzmljzm1j0nlX1olL3AJXWAAAAbXRSTlMAEBAQHx8gICAuLjAwMDw9PUBAQEpQUFBXV1hgYGBkcHBwcXl8gICAgoiIkJCQlJicnJ2goKCmqK+wsLC4usDAwMjP0NDQ1NbW3Nzg4ODi5+3v8PDw8/T09PX29vb39/f5+fr7+/z8/Pz9/v7+zczCxgAABC5JREFUeAHN1ul3k0UUBvCb1CTVpmpaitAGSLSpSuKCLWpbTKNJFGlcSMAFF63iUmRccNG6gLbuxkXU66JAUef/9LSpmXnyLr3T5AO/rzl5zj137p136BISy44fKJXuGN/d19PUfYeO67Znqtf2KH33Id1psXoFdW30sPZ1sMvs2D060AHqws4FHeJojLZqnw53cmfvg+XR8mC0OEjuxrXEkX5ydeVJLVIlV0e10PXk5k7dYeHu7Cj1j+49uKg7uLU61tGLw1lq27ugQYlclHC4bgv7VQ+TAyj5Zc/UjsPvs1sd5cWryWObtvWT2EPa4rtnWW3JkpjggEpbOsPr7F7EyNewtpBIslA7p43HCsnwooXTEc3UmPmCNn5lrqTJxy6nRmcavGZVt/3Da2pD5NHvsOHJCrdc1G2r3DITpU7yic7w/7Rxnjc0kt5GC4djiv2Sz3Fb2iEZg41/ddsFDoyuYrIkmFehz0HR2thPgQqMyQYb2OtB0WxsZ3BeG3+wpRb1vzl2UYBog8FfGhttFKjtAclnZYrRo9ryG9uG/FZQU4AEg8ZE9LjGMzTmqKXPLnlWVnIlQQTvxJf8ip7VgjZjyVPrjw1te5otM7RmP7xm+sK2Gv9I8Gi++BRbEkR9EBw8zRUcKxwp73xkaLiqQb+kGduJTNHG72zcW9LoJgqQxpP3/Tj//c3yB0tqzaml05/+orHLksVO+95kX7/7qgJvnjlrfr2Ggsyx0eoy9uPzN5SPd86aXggOsEKW2Prz7du3VID3/tzs/sSRs2w7ovVHKtjrX2pd7ZMlTxAYfBAL9jiDwfLkq55Tm7ifhMlTGPyCAs7RFRhn47JnlcB9RM5T97ASuZXIcVNuUDIndpDbdsfrqsOppeXl5Y+XVKdjFCTh+zGaVuj0d9zy05PPK3QzBamxdwtTCrzyg/2Rvf2EstUjordGwa/kx9mSJLr8mLLtCW8HHGJc2R5hS219IiF6PnTusOqcMl57gm0Z8kanKMAQg0qSyuZfn7zItsbGyO9QlnxY0eCuD1XL2ys/MsrQhltE7Ug0uFOzufJFE2PxBo/YAx8XPPdDwWN0MrDRYIZF0mSMKCNHgaIVFoBbNoLJ7tEQDKxGF0kcLQimojCZopv0OkNOyWCCg9XMVAi7ARJzQdM2QUh0gmBozjc3Skg6dSBRqDGYSUOu66Zg+I2fNZs/M3/f/Grl/XnyF1Gw3VKCez0PN5IUfFLqvgUN4C0qNqYs5YhPL+aVZYDE4IpUk57oSFnJm4FyCqqOE0jhY2SMyLFoo56zyo6becOS5UVDdj7Vih0zp+tcMhwRpBeLyqtIjlJKAIZSbI8SGSF3k0pA3mR5tHuwPFoa7N7reoq2bqCsAk1HqCu5uvI1n6JuRXI+S1Mco54YmYTwcn6Aeic+kssXi8XpXC4V3t7/ADuTNKaQJdScAAAAAElFTkSuQmCC
140
+ [binder-link]: https://notebooks.gesis.org/binder/v2/gh/r5py/r5py/stable?urlpath=tree/docs/user-guide/user-manual/quickstart.md
141
+ [build-status-badge]: https://github.com/r5py/r5py/actions/workflows/build-merged-pull-requests.yml/badge.svg
142
+ [build-status-link]: https://github.com/r5py/r5py/actions/workflows/build-merged-pull-requests.yml
143
+ [coverage-badge]: https://codecov.io/gh/r5py/r5py/branch/main/graph/badge.svg?token=WG8RBMZBK6
144
+ [coverage-link]: https://codecov.io/gh/r5py/r5py
145
+ [doi-badge]: https://zenodo.org/badge/DOI/10.5281/zenodo.7060437.svg
146
+ [doi-link]: https://doi.org/10.5281/zenodo.7060437
147
+ [downloads-conda-forge-badge]: https://img.shields.io/conda/dn/conda-forge/r5py?label=Downloads%20%28conda-forge%29
148
+ [downloads-conda-forge-link]: https://anaconda.org/conda-forge/r5py
149
+ [downloads-pypi-badge]: https://static.pepy.tech/personalized-badge/r5py?period=total&units=international_system&left_color=grey&right_color=orange&left_text=Downloads%20(pypi)
150
+ [downloads-pypi-link]: https://pypi.org/project/r5py/
151
+ [rtd-status-badge]: https://readthedocs.org/projects/r5py/badge/?version=stable
152
+ [rtd-status-link]: https://r5py.readthedocs.io/
153
+ [stable-version-badge]: https://img.shields.io/pypi/v/r5py?label=Stable
154
+ [stable-version-link]: https://github.com/r5py/r5py/releases
155
+
156
+ <!-- (2) other links -->
157
+ [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
158
+ [conveyal]: https://www.conveyal.com/
159
+ [env-file]: https://github.com/r5py/r5py/blob/main/ci/r5py.yaml
160
+ [geopandas]: https://geopandas.org/
161
+ [r5-github]: https://github.com/conveyal/r5/
162
+ [r5r-github]: https://github.com/ipeaGIT/r5r/
163
+ [r5r-vignette]: https://ipeagit.github.io/r5r/
164
+ [rtd-quickstart]: https://r5py.readthedocs.io/en/stable/user-guide/user-manual/quickstart.html
165
+ [rtd-installation]: https://r5py.readthedocs.io/en/stable/user-guide/installation/installation.html
166
+ [rtd-link]: https://r5py.readthedocs.io/
{r5py-1.0.0.dev9 → r5py-1.0.0.dev12}/README.md RENAMED
@@ -1,106 +1,106 @@
1
- <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;">
2
-
3
- # r5py: Rapid Realistic Routing with R5 in Python
4
-
5
- <!-- badges -->
6
- [![Try r5py with binder][binder-badge]][binder-link]
7
- [![DOI][doi-badge]][doi-link]
8
- <br />
9
- [![stable version][stable-version-badge]][stable-version-link]
10
- [![downloads (pypi)][downloads-pypi-badge]][downloads-pypi-link]
11
- [![downloads (conda-forge)][downloads-conda-forge-badge]][downloads-conda-forge-link]
12
- <br />
13
- [![Trunk build status][build-status-badge]][build-status-link]
14
- [![Documentation Status][rtd-status-badge]][rtd-status-link]
15
- [![Coverage][coverage-badge]][coverage-link]
16
- <br />
17
-
18
-
19
- **R5py** is a Python library for rapid realistic routing on multimodal transport
20
- networks (walk, bike, public transport and car). It provides a simple and
21
- friendly interface to R<sup>5</sup>, the Rapid Realistic Routing on Real-world
22
- and Reimagined networks, the [routing engine][r5-github] developed by Conveyal.
23
- **r5py** is inspired by [r5r, a wrapper for R][r5r-vignette], and the library is
24
- designed to interact with [GeoPandas][geopandas] GeoDataFrames.
25
-
26
- **R5py** offers a simple way to run R5 locally with Python. It allows users to
27
- calculate travel time matrices and accessibility by different travel modes. To
28
- get started, see a detailed demonstration of the **r5py** ‘in action’ from the
29
- [Usage][rtd-quickstart] section of its documentation. Over time, **r5py** will
30
- be expanded to incorporate other functionalities from R5.
31
-
32
- ## Installation
33
-
34
- **R5py** is available from conda-forge and PyPi. You can use `mamba`, `pip` or
35
- `conda` to install it. To quickstart your use of **r5py**, we also provide an
36
- [`environment.yml` file ][env-file], using which you can [quickly set up a
37
- development environment][conda-create-env-from-yml] and are ready to go.
38
-
39
- For more details and alternative installation options, read the dedicated
40
- [installation section][rtd-installation] of the r5py documentation.
41
-
42
- ## Usage
43
-
44
- You can find detailed installation instructions, example code, documentation and
45
- API reference at [r5py.readthedocs.io][rtd-link].
46
-
47
-
48
- ## Acknowledgements
49
-
50
- The [R<sup>5</sup> routing engine][r5-github] is developed at
51
- [Conveyal][conveyal] with contributions from several people.
52
-
53
- R5py draws a lot of inspiration from [r5r][r5r-github], an interface to R5 from
54
- the R language that is developed at the Institute for Applied Economic Research
55
- (Ipea), Brazil.
56
-
57
-
58
- ## Citation
59
-
60
- If you use *r5py* for scientific research, please cite it in your publications:
61
-
62
- Fink, C., Klumpenhouwer, W., Saraiva, M., Pereira, R., &amp; Tenkanen, H., 2022:
63
- *r5py: Rapid Realistic Routing with R5 in Python*.
64
- [DOI:10.5281/zenodo.7060437][doi-link]
65
-
66
-
67
- ## License
68
-
69
- This work is dual-licensed under GNU General Public License v3.0 or later and
70
- MIT License. You can choose between the two depending on which license fits
71
- your project better.
72
-
73
- `SPDX-License-Identifier: GPL-3.0-or-later OR MIT`
74
-
75
-
76
- <!-- links used throughout the document -->
77
-
78
- <!-- (1) badges -->
79
- [binder-badge]: https://img.shields.io/badge/Try%20r5py%20with-binder-F5A252.svg?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAFkAAABZCAMAAABi1XidAAAB8lBMVEX///9XmsrmZYH1olJXmsr1olJXmsrmZYH1olJXmsr1olJXmsrmZYH1olL1olJXmsr1olJXmsrmZYH1olL1olJXmsrmZYH1olJXmsr1olL1olJXmsrmZYH1olL1olJXmsrmZYH1olL1olL0nFf1olJXmsrmZYH1olJXmsq8dZb1olJXmsrmZYH1olJXmspXmspXmsr1olL1olJXmsrmZYH1olJXmsr1olL1olJXmsrmZYH1olL1olLeaIVXmsrmZYH1olL1olL1olJXmsrmZYH1olLna31Xmsr1olJXmsr1olJXmsrmZYH1olLqoVr1olJXmsr1olJXmsrmZYH1olL1olKkfaPobXvviGabgadXmsqThKuofKHmZ4Dobnr1olJXmsr1olJXmspXmsr1olJXmsrfZ4TuhWn1olL1olJXmsqBi7X1olJXmspZmslbmMhbmsdemsVfl8ZgmsNim8Jpk8F0m7R4m7F5nLB6jbh7jbiDirOEibOGnKaMhq+PnaCVg6qWg6qegKaff6WhnpKofKGtnomxeZy3noG6dZi+n3vCcpPDcpPGn3bLb4/Mb47UbIrVa4rYoGjdaIbeaIXhoWHmZYHobXvpcHjqdHXreHLroVrsfG/uhGnuh2bwj2Hxk17yl1vzmljzm1j0nlX1olL3AJXWAAAAbXRSTlMAEBAQHx8gICAuLjAwMDw9PUBAQEpQUFBXV1hgYGBkcHBwcXl8gICAgoiIkJCQlJicnJ2goKCmqK+wsLC4usDAwMjP0NDQ1NbW3Nzg4ODi5+3v8PDw8/T09PX29vb39/f5+fr7+/z8/Pz9/v7+zczCxgAABC5JREFUeAHN1ul3k0UUBvCb1CTVpmpaitAGSLSpSuKCLWpbTKNJFGlcSMAFF63iUmRccNG6gLbuxkXU66JAUef/9LSpmXnyLr3T5AO/rzl5zj137p136BISy44fKJXuGN/d19PUfYeO67Znqtf2KH33Id1psXoFdW30sPZ1sMvs2D060AHqws4FHeJojLZqnw53cmfvg+XR8mC0OEjuxrXEkX5ydeVJLVIlV0e10PXk5k7dYeHu7Cj1j+49uKg7uLU61tGLw1lq27ugQYlclHC4bgv7VQ+TAyj5Zc/UjsPvs1sd5cWryWObtvWT2EPa4rtnWW3JkpjggEpbOsPr7F7EyNewtpBIslA7p43HCsnwooXTEc3UmPmCNn5lrqTJxy6nRmcavGZVt/3Da2pD5NHvsOHJCrdc1G2r3DITpU7yic7w/7Rxnjc0kt5GC4djiv2Sz3Fb2iEZg41/ddsFDoyuYrIkmFehz0HR2thPgQqMyQYb2OtB0WxsZ3BeG3+wpRb1vzl2UYBog8FfGhttFKjtAclnZYrRo9ryG9uG/FZQU4AEg8ZE9LjGMzTmqKXPLnlWVnIlQQTvxJf8ip7VgjZjyVPrjw1te5otM7RmP7xm+sK2Gv9I8Gi++BRbEkR9EBw8zRUcKxwp73xkaLiqQb+kGduJTNHG72zcW9LoJgqQxpP3/Tj//c3yB0tqzaml05/+orHLksVO+95kX7/7qgJvnjlrfr2Ggsyx0eoy9uPzN5SPd86aXggOsEKW2Prz7du3VID3/tzs/sSRs2w7ovVHKtjrX2pd7ZMlTxAYfBAL9jiDwfLkq55Tm7ifhMlTGPyCAs7RFRhn47JnlcB9RM5T97ASuZXIcVNuUDIndpDbdsfrqsOppeXl5Y+XVKdjFCTh+zGaVuj0d9zy05PPK3QzBamxdwtTCrzyg/2Rvf2EstUjordGwa/kx9mSJLr8mLLtCW8HHGJc2R5hS219IiF6PnTusOqcMl57gm0Z8kanKMAQg0qSyuZfn7zItsbGyO9QlnxY0eCuD1XL2ys/MsrQhltE7Ug0uFOzufJFE2PxBo/YAx8XPPdDwWN0MrDRYIZF0mSMKCNHgaIVFoBbNoLJ7tEQDKxGF0kcLQimojCZopv0OkNOyWCCg9XMVAi7ARJzQdM2QUh0gmBozjc3Skg6dSBRqDGYSUOu66Zg+I2fNZs/M3/f/Grl/XnyF1Gw3VKCez0PN5IUfFLqvgUN4C0qNqYs5YhPL+aVZYDE4IpUk57oSFnJm4FyCqqOE0jhY2SMyLFoo56zyo6becOS5UVDdj7Vih0zp+tcMhwRpBeLyqtIjlJKAIZSbI8SGSF3k0pA3mR5tHuwPFoa7N7reoq2bqCsAk1HqCu5uvI1n6JuRXI+S1Mco54YmYTwcn6Aeic+kssXi8XpXC4V3t7/ADuTNKaQJdScAAAAAElFTkSuQmCC
80
- [binder-link]: https://notebooks.gesis.org/binder/v2/gh/r5py/r5py/stable?urlpath=tree/docs/user-guide/user-manual/quickstart.md
81
- [build-status-badge]: https://github.com/r5py/r5py/actions/workflows/build-merged-pull-requests.yml/badge.svg
82
- [build-status-link]: https://github.com/r5py/r5py/actions/workflows/build-merged-pull-requests.yml
83
- [coverage-badge]: https://codecov.io/gh/r5py/r5py/branch/main/graph/badge.svg?token=WG8RBMZBK6
84
- [coverage-link]: https://codecov.io/gh/r5py/r5py
85
- [doi-badge]: https://zenodo.org/badge/DOI/10.5281/zenodo.7060437.svg
86
- [doi-link]: https://doi.org/10.5281/zenodo.7060437
87
- [downloads-conda-forge-badge]: https://img.shields.io/conda/dn/conda-forge/r5py?label=Downloads%20%28conda-forge%29
88
- [downloads-conda-forge-link]: https://anaconda.org/conda-forge/r5py
89
- [downloads-pypi-badge]: https://static.pepy.tech/personalized-badge/r5py?period=total&units=international_system&left_color=grey&right_color=orange&left_text=Downloads%20(pypi)
90
- [downloads-pypi-link]: https://pypi.org/project/r5py/
91
- [rtd-status-badge]: https://readthedocs.org/projects/r5py/badge/?version=stable
92
- [rtd-status-link]: https://r5py.readthedocs.io/
93
- [stable-version-badge]: https://img.shields.io/pypi/v/r5py?label=Stable
94
- [stable-version-link]: https://github.com/r5py/r5py/releases
95
-
96
- <!-- (2) other links -->
97
- [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
98
- [conveyal]: https://www.conveyal.com/
99
- [env-file]: https://github.com/r5py/r5py/blob/main/ci/r5py_distro.yaml
100
- [geopandas]: https://geopandas.org/
101
- [r5-github]: https://github.com/conveyal/r5/
102
- [r5r-github]: https://github.com/ipeaGIT/r5r/
103
- [r5r-vignette]: https://ipeagit.github.io/r5r/
104
- [rtd-quickstart]: https://r5py.readthedocs.io/en/stable/user-guide/user-manual/quickstart.html
105
- [rtd-installation]: https://r5py.readthedocs.io/en/stable/user-guide/installation/installation.html
106
- [rtd-link]: https://r5py.readthedocs.io/
1
+ <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;">
2
+
3
+ # r5py: Rapid Realistic Routing with R5 in Python
4
+
5
+ <!-- badges -->
6
+ [![Try r5py with binder][binder-badge]][binder-link]
7
+ [![DOI][doi-badge]][doi-link]
8
+ <br />
9
+ [![stable version][stable-version-badge]][stable-version-link]
10
+ [![downloads (pypi)][downloads-pypi-badge]][downloads-pypi-link]
11
+ [![downloads (conda-forge)][downloads-conda-forge-badge]][downloads-conda-forge-link]
12
+ <br />
13
+ [![Trunk build status][build-status-badge]][build-status-link]
14
+ [![Documentation Status][rtd-status-badge]][rtd-status-link]
15
+ [![Coverage][coverage-badge]][coverage-link]
16
+ <br />
17
+
18
+
19
+ **R5py** is a Python library for rapid realistic routing on multimodal transport
20
+ networks (walk, bike, public transport and car). It provides a simple and
21
+ friendly interface to R<sup>5</sup>, the Rapid Realistic Routing on Real-world
22
+ and Reimagined networks, the [routing engine][r5-github] developed by Conveyal.
23
+ **r5py** is inspired by [r5r, a wrapper for R][r5r-vignette], and the library is
24
+ designed to interact with [GeoPandas][geopandas] GeoDataFrames.
25
+
26
+ **R5py** offers a simple way to run R5 locally with Python. It allows users to
27
+ calculate travel time matrices and accessibility by different travel modes. To
28
+ get started, see a detailed demonstration of the **r5py** ‘in action’ from the
29
+ [Usage][rtd-quickstart] section of its documentation. Over time, **r5py** will
30
+ be expanded to incorporate other functionalities from R5.
31
+
32
+ ## Installation
33
+
34
+ **R5py** is available from conda-forge and PyPi. You can use `mamba`, `pip` or
35
+ `conda` to install it. To quickstart your use of **r5py**, we also provide an
36
+ [`environment.yml` file ][env-file], using which you can [quickly set up a
37
+ development environment][conda-create-env-from-yml] and are ready to go.
38
+
39
+ For more details and alternative installation options, read the dedicated
40
+ [installation section][rtd-installation] of the r5py documentation.
41
+
42
+ ## Usage
43
+
44
+ You can find detailed installation instructions, example code, documentation and
45
+ API reference at [r5py.readthedocs.io][rtd-link].
46
+
47
+
48
+ ## Acknowledgements
49
+
50
+ The [R<sup>5</sup> routing engine][r5-github] is developed at
51
+ [Conveyal][conveyal] with contributions from several people.
52
+
53
+ R5py draws a lot of inspiration from [r5r][r5r-github], an interface to R5 from
54
+ the R language that is developed at the Institute for Applied Economic Research
55
+ (Ipea), Brazil.
56
+
57
+
58
+ ## Citation
59
+
60
+ If you use *r5py* for scientific research, please cite it in your publications:
61
+
62
+ Fink, C., Klumpenhouwer, W., Saraiva, M., Pereira, R., &amp; Tenkanen, H., 2022:
63
+ *r5py: Rapid Realistic Routing with R5 in Python*.
64
+ [DOI:10.5281/zenodo.7060437][doi-link]
65
+
66
+
67
+ ## License
68
+
69
+ This work is dual-licensed under GNU General Public License v3.0 or later and
70
+ MIT License. You can choose between the two depending on which license fits
71
+ your project better.
72
+
73
+ `SPDX-License-Identifier: GPL-3.0-or-later OR MIT`
74
+
75
+
76
+ <!-- links used throughout the document -->
77
+
78
+ <!-- (1) badges -->
79
+ [binder-badge]: https://img.shields.io/badge/Try%20r5py%20with-binder-F5A252.svg?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAFkAAABZCAMAAABi1XidAAAB8lBMVEX///9XmsrmZYH1olJXmsr1olJXmsrmZYH1olJXmsr1olJXmsrmZYH1olL1olJXmsr1olJXmsrmZYH1olL1olJXmsrmZYH1olJXmsr1olL1olJXmsrmZYH1olL1olJXmsrmZYH1olL1olL0nFf1olJXmsrmZYH1olJXmsq8dZb1olJXmsrmZYH1olJXmspXmspXmsr1olL1olJXmsrmZYH1olJXmsr1olL1olJXmsrmZYH1olL1olLeaIVXmsrmZYH1olL1olL1olJXmsrmZYH1olLna31Xmsr1olJXmsr1olJXmsrmZYH1olLqoVr1olJXmsr1olJXmsrmZYH1olL1olKkfaPobXvviGabgadXmsqThKuofKHmZ4Dobnr1olJXmsr1olJXmspXmsr1olJXmsrfZ4TuhWn1olL1olJXmsqBi7X1olJXmspZmslbmMhbmsdemsVfl8ZgmsNim8Jpk8F0m7R4m7F5nLB6jbh7jbiDirOEibOGnKaMhq+PnaCVg6qWg6qegKaff6WhnpKofKGtnomxeZy3noG6dZi+n3vCcpPDcpPGn3bLb4/Mb47UbIrVa4rYoGjdaIbeaIXhoWHmZYHobXvpcHjqdHXreHLroVrsfG/uhGnuh2bwj2Hxk17yl1vzmljzm1j0nlX1olL3AJXWAAAAbXRSTlMAEBAQHx8gICAuLjAwMDw9PUBAQEpQUFBXV1hgYGBkcHBwcXl8gICAgoiIkJCQlJicnJ2goKCmqK+wsLC4usDAwMjP0NDQ1NbW3Nzg4ODi5+3v8PDw8/T09PX29vb39/f5+fr7+/z8/Pz9/v7+zczCxgAABC5JREFUeAHN1ul3k0UUBvCb1CTVpmpaitAGSLSpSuKCLWpbTKNJFGlcSMAFF63iUmRccNG6gLbuxkXU66JAUef/9LSpmXnyLr3T5AO/rzl5zj137p136BISy44fKJXuGN/d19PUfYeO67Znqtf2KH33Id1psXoFdW30sPZ1sMvs2D060AHqws4FHeJojLZqnw53cmfvg+XR8mC0OEjuxrXEkX5ydeVJLVIlV0e10PXk5k7dYeHu7Cj1j+49uKg7uLU61tGLw1lq27ugQYlclHC4bgv7VQ+TAyj5Zc/UjsPvs1sd5cWryWObtvWT2EPa4rtnWW3JkpjggEpbOsPr7F7EyNewtpBIslA7p43HCsnwooXTEc3UmPmCNn5lrqTJxy6nRmcavGZVt/3Da2pD5NHvsOHJCrdc1G2r3DITpU7yic7w/7Rxnjc0kt5GC4djiv2Sz3Fb2iEZg41/ddsFDoyuYrIkmFehz0HR2thPgQqMyQYb2OtB0WxsZ3BeG3+wpRb1vzl2UYBog8FfGhttFKjtAclnZYrRo9ryG9uG/FZQU4AEg8ZE9LjGMzTmqKXPLnlWVnIlQQTvxJf8ip7VgjZjyVPrjw1te5otM7RmP7xm+sK2Gv9I8Gi++BRbEkR9EBw8zRUcKxwp73xkaLiqQb+kGduJTNHG72zcW9LoJgqQxpP3/Tj//c3yB0tqzaml05/+orHLksVO+95kX7/7qgJvnjlrfr2Ggsyx0eoy9uPzN5SPd86aXggOsEKW2Prz7du3VID3/tzs/sSRs2w7ovVHKtjrX2pd7ZMlTxAYfBAL9jiDwfLkq55Tm7ifhMlTGPyCAs7RFRhn47JnlcB9RM5T97ASuZXIcVNuUDIndpDbdsfrqsOppeXl5Y+XVKdjFCTh+zGaVuj0d9zy05PPK3QzBamxdwtTCrzyg/2Rvf2EstUjordGwa/kx9mSJLr8mLLtCW8HHGJc2R5hS219IiF6PnTusOqcMl57gm0Z8kanKMAQg0qSyuZfn7zItsbGyO9QlnxY0eCuD1XL2ys/MsrQhltE7Ug0uFOzufJFE2PxBo/YAx8XPPdDwWN0MrDRYIZF0mSMKCNHgaIVFoBbNoLJ7tEQDKxGF0kcLQimojCZopv0OkNOyWCCg9XMVAi7ARJzQdM2QUh0gmBozjc3Skg6dSBRqDGYSUOu66Zg+I2fNZs/M3/f/Grl/XnyF1Gw3VKCez0PN5IUfFLqvgUN4C0qNqYs5YhPL+aVZYDE4IpUk57oSFnJm4FyCqqOE0jhY2SMyLFoo56zyo6becOS5UVDdj7Vih0zp+tcMhwRpBeLyqtIjlJKAIZSbI8SGSF3k0pA3mR5tHuwPFoa7N7reoq2bqCsAk1HqCu5uvI1n6JuRXI+S1Mco54YmYTwcn6Aeic+kssXi8XpXC4V3t7/ADuTNKaQJdScAAAAAElFTkSuQmCC
80
+ [binder-link]: https://notebooks.gesis.org/binder/v2/gh/r5py/r5py/stable?urlpath=tree/docs/user-guide/user-manual/quickstart.md
81
+ [build-status-badge]: https://github.com/r5py/r5py/actions/workflows/build-merged-pull-requests.yml/badge.svg
82
+ [build-status-link]: https://github.com/r5py/r5py/actions/workflows/build-merged-pull-requests.yml
83
+ [coverage-badge]: https://codecov.io/gh/r5py/r5py/branch/main/graph/badge.svg?token=WG8RBMZBK6
84
+ [coverage-link]: https://codecov.io/gh/r5py/r5py
85
+ [doi-badge]: https://zenodo.org/badge/DOI/10.5281/zenodo.7060437.svg
86
+ [doi-link]: https://doi.org/10.5281/zenodo.7060437
87
+ [downloads-conda-forge-badge]: https://img.shields.io/conda/dn/conda-forge/r5py?label=Downloads%20%28conda-forge%29
88
+ [downloads-conda-forge-link]: https://anaconda.org/conda-forge/r5py
89
+ [downloads-pypi-badge]: https://static.pepy.tech/personalized-badge/r5py?period=total&units=international_system&left_color=grey&right_color=orange&left_text=Downloads%20(pypi)
90
+ [downloads-pypi-link]: https://pypi.org/project/r5py/
91
+ [rtd-status-badge]: https://readthedocs.org/projects/r5py/badge/?version=stable
92
+ [rtd-status-link]: https://r5py.readthedocs.io/
93
+ [stable-version-badge]: https://img.shields.io/pypi/v/r5py?label=Stable
94
+ [stable-version-link]: https://github.com/r5py/r5py/releases
95
+
96
+ <!-- (2) other links -->
97
+ [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
98
+ [conveyal]: https://www.conveyal.com/
99
+ [env-file]: https://github.com/r5py/r5py/blob/main/ci/r5py.yaml
100
+ [geopandas]: https://geopandas.org/
101
+ [r5-github]: https://github.com/conveyal/r5/
102
+ [r5r-github]: https://github.com/ipeaGIT/r5r/
103
+ [r5r-vignette]: https://ipeagit.github.io/r5r/
104
+ [rtd-quickstart]: https://r5py.readthedocs.io/en/stable/user-guide/user-manual/quickstart.html
105
+ [rtd-installation]: https://r5py.readthedocs.io/en/stable/user-guide/installation/installation.html
106
+ [rtd-link]: https://r5py.readthedocs.io/