RoadProfile documentation
=======================================================

RoadProfile is a python package for road engineers that implements texture metrics
(e.g. MPD) and filtering techniques widely used in road related research and asset management.
See the :ref:`introduction` for a general overview of this package and general 
implementation considerations.

Note that it is *not* an introduction to the road metrics implemented here.
Familiarity with the basic concepts, measurement techniques etc. is assumed.

.. warning::
    This is still under development and is in a very unfinished state.

.. toctree::
   :maxdepth: 2

   intro
   api_reference

.. todolist::

This documentation was built |today|.

Source code
-----------
The source code and installation instructions can be found `here <https://github.com/roadtools/roadprofile/>`_

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`