.. _api_reference:

API Reference
=============

Project
-------
.. currentmodule:: aequilibrae.project
.. autosummary::
   :toctree: generated/

   Project

Project Components
~~~~~~~~~~~~~~~~~~
.. currentmodule:: aequilibrae.project
.. autosummary::
   :toctree: generated/

   About
   FieldEditor
   Log
   Matrices
   Network
   Zoning

Project Objects
~~~~~~~~~~~~~~~
.. currentmodule:: aequilibrae.project
.. autosummary::
   :toctree: generated/

   Zone

Network Data
------------
.. currentmodule:: aequilibrae.project.network
.. autosummary::
   :toctree: generated/

   Modes
   LinkTypes
   Links
   Nodes
   Periods

Network Items
-------------
.. currentmodule:: aequilibrae.project.network
.. autosummary::
   :toctree: generated/

   Mode
   LinkType
   Link
   Node
   Period

Distribution
------------
.. currentmodule:: aequilibrae.distribution
.. autosummary::
   :toctree: generated/

   Ipf
   GravityCalibration
   GravityApplication
   SyntheticGravityModel

Matrix
------
.. currentmodule:: aequilibrae.matrix
.. autosummary::
   :toctree: generated/

   AequilibraeMatrix

Paths
-----

Skimming
~~~~~~~~
.. currentmodule:: aequilibrae.paths
.. autosummary::
   :toctree: generated/

   NetworkSkimming

Graph
~~~~~
.. currentmodule:: aequilibrae.paths
.. autosummary::
   :toctree: generated/

   Graph
   TransitGraph
   
Traffic assignment
~~~~~~~~~~~~~~~~~~
.. currentmodule:: aequilibrae.paths
.. autosummary::
   :toctree: generated/
   
   TrafficClass
   TransitClass
   VDF
   TrafficAssignment
   TransitAssignment
   AssignmentResults
   TransitAssignmentResults
   SkimResults
   PathResults

Route choice
~~~~~~~~~~~~
.. currentmodule:: aequilibrae.paths
.. autosummary::
   :toctree: generated/

   HyperpathGenerating
   OptimalStrategies
   RouteChoice
   SubAreaAnalysis

Transit
-------
.. currentmodule:: aequilibrae.transit
.. autosummary::
   :toctree: generated/

   Transit
   TransitGraphBuilder
   lib_gtfs.GTFSRouteSystemBuilder

Utils
-----
.. currentmodule:: aequilibrae.utils
.. autosummary::
   :toctree: generated/

   create_delaunay_network.DelaunayAnalysis
   create_example

Parameters
----------
.. currentmodule:: aequilibrae
.. autosummary::
   :toctree: generated/

   Parameters
