.. MiMap documentation master file, created by
   sphinx-quickstart on Fri Jan 22 21:33:12 2021.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Michigan Traffic Lab Data Platform (MTLDP)
######################################################

Introduction
============================

MTL data platform is a Python package that can help you you build your own applications based on connected
vehicle trajectory data as well as the network modeling and analysis. MTLDP provides a series of fundamental functions
that help to parse, process, and match the trajectory data, map data, and signal state data. It also has certain
higher-level applications with regard to both safety and mobility measurements and optimization.

Features
===============================================

MTLDP could help those who want to implement applications based on **connected vehicle trajectory data** including
map matching, trajectory processing, etc. MTLDP can also help researches related to **transportation network modeling**
and **network analysis**. The main features of MTLDP includes:

* Parse the OpenStreetMap data and construct a well-defined network object;
* Different data adapters to load vehicle trajectory data and SPaT data;
* Match the trajectory data to the map and the SPat;
* Basic trajectory processing functions including smoothing, filtering, coordination conversion, etc;
* Some applications based on trajectory data including both safety and mobility.

Reference
==================================================

* Documentation is available on `[mtldp docs] <https://xingminw.github.io/mtldp/>`_

Authors
============================

MTLDP is developed by `Michigan Traffic Lab <https://traffic.engin.umich.edu/>`_.


.. todo(shengyin): add the full author list | Zachary Jerome           |
   +--------------------------+-----------------------------------+------------------------------------------+
   | Name                     | Email                             | Introduction                             |
   +==========================+===================================+==========================================+
   | Henry Liu                | henryliu@umich.edu                | Advisor                                  |
   +--------------------------+-----------------------------------+------------------------------------------+
   | Xingmin Wang             | xingminw@umich.edu                | Ph.D. student                            |
   +--------------------------+-----------------------------------+------------------------------------------+



.. toctree::
   :hidden:
   :maxdepth: -1
   :caption: Overview
   :titlesonly:

   overview/introduction.rst
   overview/installation.rst
   overview/map_intro.rst
   overview/trajectory.rst
   overview/spat.rst

.. toctree::
   :hidden:
   :maxdepth: -1
   :caption: Tutorial

   tutorial/map_parse.rst
   tutorial/trajs_adapters.rst

.. toctree::
   :maxdepth: -1
   :hidden:
   :caption: Reference

   reference/general.rst
   reference/mtlmap.rst
   reference/mtltrajs.rst
   reference/spat.rst
   reference/utils.rst

.. toctree::
   :hidden:
   :maxdepth: -1
   :caption: Developer

   README.rst
   developer/jupyter.rst