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

.. panels::
   :card: text-center bg-transparent border-light
   :container: container pb-3
   :header: text-center border-light
   :footer: border-light
   :column: col-lg-6 col-md-6 col-sm-6 col-xs-12 p-2

   ---
   :column: col-lg-12 p-2
   :fa:`folder`
   **Getting Started**
   ^^^^^^^^^^^^^^^^^

   New to AequilibraE? Get started here!

   +++++++++++++++++

   .. link-button:: getting_started
      :type: ref
      :text: Getting Started
      :classes: btn-block btn-secondary stretched-link

   ---
   :column: col-lg-12 p-2
   :fa:`folder`
   **Using AequilibraE**
   ^^^^^^^^^^^^^^^^^

   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.

   +++++++++++++++++

   .. link-button:: _auto_examples/index
      :type: ref
      :text: Examples
      :classes: btn-block btn-secondary stretched-link

   ---
   :fa:`book`
   **Modeling with AequilibraE**
   ^^^^^^^^^^^^^^^^^^^^^^^^^

   An in-depth guide to modeling with AequilibraE, including the concepts that guide its
   development and user-experience.

   +++++++++++++++++

   .. link-button:: modeling_with_aequilibrae
         :type: ref
         :text: Modeling with AequilibraE
         :classes: btn-block btn-secondary stretched-link
   
   ---

   :fa:`tools`
   **API References**
   ^^^^^^^^^^^^^^

   Reference guide to AequilibraE's API.

   +++++++++++++++++

   .. link-button:: api
         :type: ref
         :text: API references
         :classes: btn-block btn-secondary stretched-link
   
   ---

   :fa:`check`
   **Software Validation & Benchmarking**
   ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

   Want to see how we test the software for correctness and performance?

   ++++++++++++++++++++++++++++++++++

   .. link-button:: validation
         :type: ref
         :text: Validation & Benchmarking
         :classes: btn-block btn-secondary stretched-link

   ---

   :fa:`lightbulb`
   **Developing**
   ^^^^^^^^^^^^

   Looking for something more than using the software? Check out the development info.

   ++++++++++++

   .. link-button:: developing
         :type: ref
         :text: Developing
         :classes: btn-block btn-secondary stretched-link


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

   getting_started
   _auto_examples/index
   modeling_with_aequilibrae
   api
   validation
   developing

Note to users
=============

AequilibraE is developed by a small but dedicated team of professionals without
any funding or profit from this work, so if your organization is making use of
AequilibraE, please consider funding some of the new developments or maintenance
of the project.

**We appreciate it if you do not send questions directly to the developers**, but
there are two alternatives for support:

1. Posting your question to `GIS StackOverflow <https://gis.stackexchange.com/>`_ using the #aequilibrae tag;
2. Joining the `AequilibraE Google Group <https://groups.google.com/forum/#!forum/aequilibrae>`_
   and sending your question there.

AequilibraE **does not have paid support** but if you are looking to hire its developers
for specific projects or to **fund AequilibraE's** development,
please e-mail the developers at contact@aequilibrae.com.

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