API Reference

aequilibrae.setup()

aequilibrae.cleaning()

Project

Project

AequilibraE project class

Project Components

About	Provides an interface for querying and editing the about table of an AequilibraE project
FieldEditor	Allows user to edit the project data tables
Log	API entry point to the log file contents
Matrices	Gateway into the matrices available/recorded in the model
Network	Network class.
Zoning	Access to the API resources to manipulate the zones table in the project

Project Objects

Zone	Single zone object that can be queried and manipulated in memory

Network Data

Modes	Access to the API resources to manipulate the modes table in the network
LinkTypes	Access to the API resources to manipulate the link_types table in the network.
Links	Access to the API resources to manipulate the links table in the network
Nodes	Access to the API resources to manipulate the links table in the network
Periods	Access to the API resources to manipulate the links table in the network

Network Items

Mode	A mode object represents a single record in the modes table
LinkType	A link_type object represents a single record in the link_types table
Link	A Link object represents a single record in the links table
Node	A Node object represents a single record in the nodes table
Period	A Period object represents a single record in the periods table

Parameters

Parameters

Global parameters module

Distribution

Ipf([project])	Iterative proportional fitting procedure
GravityApplication([project])	Applies a synthetic gravity model.
GravityCalibration([project])	Calibrate a traditional gravity model
SyntheticGravityModel()	Simple class object to represent synthetic gravity models

Matrix

AequilibraeData	AequilibraE dataset
AequilibraeMatrix	Matrix class

Paths

Graph
TransitGraph
AssignmentResults	Assignment result holder for a single TrafficClass with multiple user classes
TransitAssignmentResults	Assignment result holder for a single Transit
SkimResults	Network skimming result holder.
PathResults	Path computation result holder
VDF	Volume-Delay function
TrafficClass	Traffic class for equilibrium traffic assignment
TransitClass
TrafficAssignment	Traffic assignment class.
TransitAssignment
HyperpathGenerating	A class for hyperpath generation.
OptimalStrategies

Transit

Transit
TransitGraphBuilder	Graph builder for the transit assignment Spiess & Florian algorithm.