.. 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.

.. seealso::

   If you are looking for the documentation for **QAequilibraE (the companion QGIS Plugin)**, you can
   see it on its `own webpage <http://www.aequilibrae.com/qgis>`_.

.. grid::

    .. grid-item-card:: :material-twotone:`folder;1.5em` Getting Started
        :link: getting_started
        :link-type: ref
        :text-align: center
        
        New to AequilibraE? Get started here!

.. grid::

    .. grid-item-card:: :material-twotone:`folder;1.5em` Using AequilibraE
        :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::

    .. grid-item-card:: :material-twotone:`menu_book;1.5em` Modeling with AequilibraE
        :link: modeling_with_aequilibrae
        :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-item-card:: :material-twotone:`build;1.5em` API References
        :link: api_reference
        :link-type: ref
        :text-align: center
        
        Reference guide to AequilibraE's API.

.. grid::

    .. grid-item-card:: :material-twotone:`check;1.5em` Software Validation & Benchmarking
        :link: validation
        :link-type: any
        :text-align: center
        
        Want to see how we test the software for correctness and performance?

    .. grid-item-card:: :material-twotone:`lightbulb;1.5em` Developing
        :link: developing_aequilibrae
        :link-type: ref
        :text-align: center
        
        Looking for something more than using the software? Check out the development info.

.. grid::

    .. grid-item-card:: :material-twotone:`support_agent;1.5em` Support and sponsors
        :link: support
        :link-type: ref
        :text-align: center
        
        Support for AequilibraE is available in multiple forms. Check the most adequate for your case and the list
        of supporters here.

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

   getting_started
   _auto_examples/index
   modeling_with_aequilibrae
   api
   validation
   developing
   history

.. note::

   If you want to check any of AequilibraE's versions before 0.9.0, you can checkout their
   documentation in :ref:`this page <versionhistory>`