# mappymatch
Mappymatch is a pure-python package developed and open sourced by the National Renewable Energy Laboratory. It contains a collection of "Matchers" that enable matching a GPS trace (series of GPS coordinates) to a map.
The current matchers are:
- `LCSSMatcher`: A matcher that implements the LCSS algorithm described in this [paper](https://doi.org/10.3141%2F2645-08). Works best with high resolution GPS traces.
- `OsrmMatcher`: A light matcher that pings an OSRM server to request map matching results. See the [official documentation](http://project-osrm.org/) for more info.
- `ValhallaMatcher`: A matcher to ping a [Valhalla](https://www.interline.io/valhalla/) server for map matching results.
Currently supported map formats are:
- Open Street Maps
## Installation
```console
pip install mappymatch
```
If you have trouble with that, check out [the docs](https://nrel.github.io/mappymatch/install.html) for more detailed install instructions.
## Example Usage
The current primary workflow is to use [osmnx](https://github.com/gboeing/osmnx) to download a road network and match it using the `LCSSMatcher`.
The `LCSSMatcher` implements the map matching algorithm described in this paper:
[Zhu, Lei, Jacob R. Holden, and Jeffrey D. Gonder.
"Trajectory Segmentation Map-Matching Approach for Large-Scale, High-Resolution GPS Data."
Transportation Research Record: Journal of the Transportation Research Board 2645 (2017): 67-75.](https://doi.org/10.3141%2F2645-08)
usage:
```python
from mappymatch import package_root
from mappymatch.constructs.geofence import Geofence
from mappymatch.constructs.trace import Trace
from mappymatch.maps.nx.nx_map import NxMap
from mappymatch.matchers.lcss.lcss import LCSSMatcher
trace = Trace.from_csv(package_root() / "resources/traces/sample_trace_1.csv")
# generate a geofence polygon that surrounds the trace; units are in meters;
# this is used to query OSM for a small map that we can match to
geofence = Geofence.from_trace(trace, padding=1e3)
# uses osmnx to pull a networkx map from the OSM database
nx_map = NxMap.from_geofence(geofence)
matcher = LCSSMatcher(nx_map)
matches = matcher.match_trace(trace)
# convert the matches to a dataframe
df = matches.matches_to_dataframe()
```
## Example Notebooks
Check out the [LCSS Example](https://nrel.github.io/mappymatch/lcss-example.html) for a more detailed example of working with the LCSSMatcher.
Raw data
{
"_id": null,
"home_page": null,
"name": "mappymatch",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "GPS, map, match",
"author": "National Renewable Energy Laboratory",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/6f/f6/1cc7e32a388e903552e33caf899e7f13eb5e7946f9b72117d66312524e50/mappymatch-0.6.0.tar.gz",
"platform": null,
"description": "# mappymatch\n\nMappymatch is a pure-python package developed and open sourced by the National Renewable Energy Laboratory. It contains a collection of \"Matchers\" that enable matching a GPS trace (series of GPS coordinates) to a map.\n\n\n\nThe current matchers are:\n\n- `LCSSMatcher`: A matcher that implements the LCSS algorithm described in this [paper](https://doi.org/10.3141%2F2645-08). Works best with high resolution GPS traces.\n- `OsrmMatcher`: A light matcher that pings an OSRM server to request map matching results. See the [official documentation](http://project-osrm.org/) for more info.\n- `ValhallaMatcher`: A matcher to ping a [Valhalla](https://www.interline.io/valhalla/) server for map matching results.\n\nCurrently supported map formats are:\n\n- Open Street Maps\n\n## Installation\n\n```console\npip install mappymatch\n```\n\nIf you have trouble with that, check out [the docs](https://nrel.github.io/mappymatch/install.html) for more detailed install instructions.\n\n## Example Usage\n\nThe current primary workflow is to use [osmnx](https://github.com/gboeing/osmnx) to download a road network and match it using the `LCSSMatcher`.\n\nThe `LCSSMatcher` implements the map matching algorithm described in this paper:\n\n[Zhu, Lei, Jacob R. Holden, and Jeffrey D. Gonder.\n\"Trajectory Segmentation Map-Matching Approach for Large-Scale, High-Resolution GPS Data.\"\nTransportation Research Record: Journal of the Transportation Research Board 2645 (2017): 67-75.](https://doi.org/10.3141%2F2645-08)\n\nusage:\n\n```python\nfrom mappymatch import package_root\nfrom mappymatch.constructs.geofence import Geofence\nfrom mappymatch.constructs.trace import Trace\nfrom mappymatch.maps.nx.nx_map import NxMap\nfrom mappymatch.matchers.lcss.lcss import LCSSMatcher\n\ntrace = Trace.from_csv(package_root() / \"resources/traces/sample_trace_1.csv\")\n\n# generate a geofence polygon that surrounds the trace; units are in meters;\n# this is used to query OSM for a small map that we can match to\ngeofence = Geofence.from_trace(trace, padding=1e3)\n\n# uses osmnx to pull a networkx map from the OSM database\nnx_map = NxMap.from_geofence(geofence)\n\nmatcher = LCSSMatcher(nx_map)\n\nmatches = matcher.match_trace(trace)\n\n# convert the matches to a dataframe\ndf = matches.matches_to_dataframe()\n```\n\n## Example Notebooks\n\nCheck out the [LCSS Example](https://nrel.github.io/mappymatch/lcss-example.html) for a more detailed example of working with the LCSSMatcher.\n",
"bugtrack_url": null,
"license": "BSD 3-Clause License Copyright (c) 2022, Alliance for Sustainable Energy, LLC",
"summary": "Pure python package for map-matching.",
"version": "0.6.0",
"project_urls": {
"Homepage": "https://github.com/NREL/mappymatch"
},
"split_keywords": [
"gps",
" map",
" match"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a6505df672366ca40eab999bf926bc1be5db5fe118c2e1a89d5f1edbaacc945d",
"md5": "bd67bf609a6050844e166cc3009ac406",
"sha256": "54d1ddaa34522175e70d547d1f4adf0435dd832ec936ca41604fe696025e6a1e"
},
"downloads": -1,
"filename": "mappymatch-0.6.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "bd67bf609a6050844e166cc3009ac406",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 53724,
"upload_time": "2025-01-13T16:58:29",
"upload_time_iso_8601": "2025-01-13T16:58:29.496358Z",
"url": "https://files.pythonhosted.org/packages/a6/50/5df672366ca40eab999bf926bc1be5db5fe118c2e1a89d5f1edbaacc945d/mappymatch-0.6.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6ff61cc7e32a388e903552e33caf899e7f13eb5e7946f9b72117d66312524e50",
"md5": "dd6187a50bf7696cd5b6ea5b12ed8aa6",
"sha256": "2a616a58c8de9615f7c2740f5fdd461ca7de4927525de1c2f072715d7d7d88b7"
},
"downloads": -1,
"filename": "mappymatch-0.6.0.tar.gz",
"has_sig": false,
"md5_digest": "dd6187a50bf7696cd5b6ea5b12ed8aa6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 46219,
"upload_time": "2025-01-13T16:58:30",
"upload_time_iso_8601": "2025-01-13T16:58:30.928732Z",
"url": "https://files.pythonhosted.org/packages/6f/f6/1cc7e32a388e903552e33caf899e7f13eb5e7946f9b72117d66312524e50/mappymatch-0.6.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-13 16:58:30",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "NREL",
"github_project": "mappymatch",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "mappymatch"
}
JSON
