Metadata-Version: 2.1
Name: mapmatcher
Version: 0.1
Summary: A package to map-match GPS traces onto an arbitrary network
Author: Pedro Camargo
Maintainer-email: Pedro Camargo <pedro@outerloop.io>
License: MIT
Project-URL: Homepage, https://github.com/pedrocamargo/map_matching
Classifier: Development Status :: 3 - Alpha
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Topic :: Scientific/Engineering
Description-Content-Type: text/markdown
Requires-Dist: aequilibrae
Requires-Dist: geopandas
Provides-Extra: dev
Requires-Dist: mapmatcher[docs,formatting,linting] ; extra == 'dev'
Provides-Extra: docs
Requires-Dist: aequilibrae ; extra == 'docs'
Requires-Dist: geopandas ; extra == 'docs'
Requires-Dist: Sphinx ; extra == 'docs'
Requires-Dist: sphinx-theme ; extra == 'docs'
Requires-Dist: sphinx-autodoc-annotation ; extra == 'docs'
Requires-Dist: nbsphinx ; extra == 'docs'
Requires-Dist: pydata-sphinx-theme ; extra == 'docs'
Requires-Dist: pandoc ; extra == 'docs'
Requires-Dist: sphinx-gallery ; extra == 'docs'
Provides-Extra: formatting
Requires-Dist: black ; extra == 'formatting'
Requires-Dist: isort ; extra == 'formatting'
Provides-Extra: linting
Requires-Dist: ruff ; extra == 'linting'
Requires-Dist: pytest ; extra == 'linting'

# MapMatcher
MapMatcher is yet another Python Package designed to map-match GPS traces onto a network.

This package is built around [AequilibraE](https://www.aequilibrae.com) adding new powerful resources to its ecosystem.

Following on the AequilibraE ethos, however, one does not need an AequilibraE model 
to use MapMatcher to map-match GPS traces to a bespoke link network.

## Install

```
pip install mapmatcher
```

## Documentation

MapMatcher documentation can be found [here](docs/source/index.md)!

## Example

To check more MapMatcher examples, check [here](docs/source/examples).

```python
from mapmatcher import MapMatcher

mmatcher = MapMatcher.from_aequilibrae(project, "c")
mmatcher.load_gps_traces(gps_traces)
mmatcher.execute()
```

## Citing
Case you use MapMatcher, please cite:

> P. Camargo, S. Hong, and V. Livshits, ‘Expanding the Uses of Truck GPS Data in Freight Modeling and Planning Activities’, Transportation Research Record, vol. 2646, no. 1, pp. 68–76, Jan. 2017, [doi: 10.3141/2646-08](https://journals.sagepub.com/doi/abs/10.3141/2646-08).
