.. _aequilibrae_api:

API documentation
=================

.. automodule:: aequilibrae
   :no-members:
   :no-undoc-members:
   :no-inherited-members:
   :no-show-inheritance:

Project Module
--------------

.. currentmodule:: aequilibrae

.. autosummary::
   :nosignatures:
   :toctree: _generated

    Project

Project components
++++++++++++++++++

.. currentmodule:: aequilibrae.project

.. autosummary::
   :nosignatures:
   :toctree: _generated

    About
    FieldEditor
    Log
    Matrices
    Network
    Zoning

Project objects
++++++++++++++++++

.. currentmodule:: aequilibrae.project

.. autosummary::
   :nosignatures:
   :toctree: _generated

    Zone

Network data
~~~~~~~~~~~~

.. currentmodule:: aequilibrae.project.network

.. autosummary::
   :nosignatures:
   :toctree: _generated

    Modes
    LinkTypes
    Links
    Nodes

Network items
~~~~~~~~~~~~~

.. currentmodule:: aequilibrae.project.network

.. autosummary::
   :nosignatures:
   :toctree: _generated


    Mode
    LinkType
    Link
    Node

Parameters Module
-----------------

.. currentmodule:: aequilibrae

.. autosummary::
   :nosignatures:
   :toctree: _generated

    Parameters

Distribution Module
-------------------

.. currentmodule:: aequilibrae

.. autosummary::
   :nosignatures:
   :toctree: _generated

    Ipf
    GravityApplication
    GravityCalibration
    SyntheticGravityModel

Matrix Module
-------------

.. currentmodule:: aequilibrae

.. autosummary::
   :nosignatures:
   :toctree: _generated

    AequilibraeMatrix
    AequilibraeData

Paths Module
------------

.. currentmodule:: aequilibrae

.. autosummary::
   :nosignatures:
   :toctree: _generated

    Graph
    AssignmentResults
    SkimResults
    PathResults
    VDF
    TrafficClass
    TrafficAssignment

Transit Module
--------------

.. currentmodule:: aequilibrae

.. autosummary::
   :nosignatures:
   :toctree: _generated

    GTFS
    create_gtfsdb

Use examples
------------

.. toctree::
   :maxdepth: 1

   usageexamples