.. AequilibraE documentation master file, created by
   sphinx-quickstart on Fri Jul  6 17:02:38 2018.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

===========
AequilibraE
===========

AequilibraE is the first comprehensive Python package for transportation modeling, and it aims to provide all the 
resources not easily available from other open-source packages in the Python (NumPy, really) ecosystem.

**Download documentation**: :download:`HTML <_static/AequilibraE.zip>` | :download:`PDF <_static/latex/AequilibraE.pdf>`

**Previous versions**: documentation for AequilibraE's versions before 0.9.0 are available :ref:`here <versionhistory>`.

**Useful links**: :ref:`installation` | :ref:`validation` | :ref:`developing_aequilibrae` | :ref:`support` | 
:ref:`history_of_aequilibrae`

.. grid::

    .. grid-item-card:: :material-outlined:`folder;1.5em` Examples
        :link: _auto_examples/index
        :link-type: any
        :text-align: center
        
        A series of examples on how to use AequilibraE, from building a model from scratch
        to editing an existing, performing trip distribution or traffic assignment to analyzing
        results.

    .. grid-item-card:: :material-outlined:`menu_book;1.5em` Modeling with AequilibraE
        :link: modeling_with_aequilibrae/index
        :link-type: any
        :text-align: center
        
        An in-depth guide to modeling with AequilibraE, including the concepts that guide its
        development and user-experience.

.. grid::
    
    .. grid-item-card:: :material-outlined:`build;1.5em` API References
        :link: api_reference
        :link-type: ref
        :text-align: center
        
        Reference guide to AequilibraE's API.

    .. grid-item-card:: :material-outlined:`person;1.5em` Not a programmer?
        :link: https://www.aequilibrae.com/qgis/latest/
        :text-align: center
        
        Take me to the GUI!

.. toctree::
   :hidden:
   :maxdepth: 1

   _auto_examples/index
   modeling_with_aequilibrae/index
   api/api
