# 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 and planned 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
```
pip install mappymatch
```
If you have trouble with that, check out [the docs](https://mappymatch.readthedocs.io/en/latest/general/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
Example JupyterLab notebooks making use of mappymatch can be found in the [mappymatch examples repository](https://github.com/NREL/mappymatch-examples).
Raw data
{
"_id": null,
"home_page": "",
"name": "mappymatch",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "GPS,map,match",
"author": "National Renewable Energy Laboratory",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/09/db/52941e6ab0609d8ca053eccd2b8db9f86c2d94af0e3f6655aef0f838041f/mappymatch-0.4.1.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\nThe current and planned 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```\npip install mappymatch\n```\n\nIf you have trouble with that, check out [the docs](https://mappymatch.readthedocs.io/en/latest/general/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\nExample JupyterLab notebooks making use of mappymatch can be found in the [mappymatch examples repository](https://github.com/NREL/mappymatch-examples).\n",
"bugtrack_url": null,
"license": "BSD 3-Clause License Copyright (c) 2022, Alliance for Sustainable Energy, LLC",
"summary": "Package for mapmatching.",
"version": "0.4.1",
"project_urls": {
"Homepage": "https://github.com/NREL/mappymatch"
},
"split_keywords": [
"gps",
"map",
"match"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "cbe454c5cf21b830b927702c3330ba3b5db97a698be962530afc96cecc86112d",
"md5": "df9b47c182ab863110675fb76e0d5ab0",
"sha256": "b9ec6f9aae819ae47985f64b56dee6fa2f67d210be256b27ee6d4581ad38f99f"
},
"downloads": -1,
"filename": "mappymatch-0.4.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "df9b47c182ab863110675fb76e0d5ab0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 52971,
"upload_time": "2023-07-17T20:18:51",
"upload_time_iso_8601": "2023-07-17T20:18:51.440760Z",
"url": "https://files.pythonhosted.org/packages/cb/e4/54c5cf21b830b927702c3330ba3b5db97a698be962530afc96cecc86112d/mappymatch-0.4.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "09db52941e6ab0609d8ca053eccd2b8db9f86c2d94af0e3f6655aef0f838041f",
"md5": "50583d7c165d809b31a20c711a9ef813",
"sha256": "04138550df2d0a74cae17a510503a127358c8a17e64bbb3fa1ae3ab5da8944b9"
},
"downloads": -1,
"filename": "mappymatch-0.4.1.tar.gz",
"has_sig": false,
"md5_digest": "50583d7c165d809b31a20c711a9ef813",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 52062,
"upload_time": "2023-07-17T20:18:53",
"upload_time_iso_8601": "2023-07-17T20:18:53.253919Z",
"url": "https://files.pythonhosted.org/packages/09/db/52941e6ab0609d8ca053eccd2b8db9f86c2d94af0e3f6655aef0f838041f/mappymatch-0.4.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-17 20:18:53",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "NREL",
"github_project": "mappymatch",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"tox": true,
"lcname": "mappymatch"
}
JSON
