"yet another map matcher" is a pure-python package developed by the National Renewable Energy Laboratory that maintains a collection of map matching algorithms and wrappers. The package was designed for ease of use and portabilty across platforms.
Clone the repo:
git clone https://github.com/NREL/yamm.git
Then, setup a python environment with python >= 3.8:
conda create -n yamm python=3.8
Finally, use pip to install the package:
conda activate yamm
pip install -e <path/to/yamm>[plot]
There are a couple of extras available:
osrm: Needed by theOsrmMatcherto connect to the OSRM API.plot: Needed to plot the result.
At least plot is needed to run the examples.
If you have issues installing the package and dependencies using pip you can try using conda to install the dependencies:
Clone the repo:
git clone https://github.com/NREL/yamm.git
Then, use the provided environment.yml file to install dependencies:
conda env create -f environment.yml
Finally, use pip to install the package:
conda activate yamm
pip install -e <path/to/yamm>[plot]
The current primary workflow is to use osmnx to download a road network and match it using the LCSSMatcher.
The LCSSMatcher implements the map matching algorithm described in this paper:
usage:
from yamm import root
from yamm.matchers.lcss.lcss import LCSSMatcher
from yamm.utils.geo import geofence_from_trace
from yamm.maps.nx.readers.osm_readers import read_osm_nxmap
from yamm.constructs.trace import Trace
trace = Trace.from_csv(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
road_map = read_osm_nxmap(geofence)
matcher = LCSSMatcher(road_map)
matches = matcher.match_trace(trace)