API Reference#

Project#

Project()

AequilibraE project class

Project Components#

About(project)

Provides an interface for querying and editing the about table of an AequilibraE project

FieldEditor(project, table_name)

Allows user to edit the project data tables

Log(project_base_path)

API entry point to the log file contents

Matrices(project)

Gateway into the matrices available/recorded in the model

Network(project)

Network class.

Zoning(network)

Access to the API resources to manipulate the 'zones' table in the project

Project Objects#

Zone(dataset, zoning)

Single zone object that can be queried and manipulated in memory

Network Data#

Modes(net)

Access to the API resources to manipulate the modes table in the network

LinkTypes(net)

Access to the API resources to manipulate the link_types table in the network.

Links(net)

Access to the API resources to manipulate the links table in the network

Nodes(net)

Access to the API resources to manipulate the nodes table in the network

Periods(net)

Access to the API resources to manipulate the periods table in the network

Network Items#

Mode(mode_id, project)

A mode object represents a single record in the modes table

LinkType(data_set, project)

A link_type object represents a single record in the link_types table

Link(dataset, project)

A Link object represents a single record in the links table

Node(dataset, project)

A Node object represents a single record in the nodes table

Period(dataset, project)

A Period object represents a single record in the periods table

Distribution#

Ipf([project])

Iterative proportional fitting procedure

GravityCalibration([project])

Calibrate a traditional gravity model

GravityApplication([project])

Applies a synthetic gravity model.

SyntheticGravityModel()

Simple class object to represent synthetic gravity models

Matrix#

AequilibraeMatrix()

Matrix class

Paths#

Skimming#

NetworkSkimming(graph[, origins, project])

Graph#

Graph(*args, **kwargs)

TransitGraph([config, od_node_mapping])

Traffic assignment#

TrafficClass(name, graph, matrix)

Traffic class for equilibrium traffic assignment

TransitClass(name, graph, matrix[, matrix_core])

VDF()

Volume-Delay function

TrafficAssignment([project])

Traffic assignment class.

TransitAssignment(*args[, project])

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

Route choice#

HyperpathGenerating(edges[, tail, head, ...])

A class for hyperpath generation.

OptimalStrategies(assig_spec)

RouteChoice(graph[, project])

SubAreaAnalysis(graph, subarea, demand[, ...])

Transit#

Transit(project)

TransitGraphBuilder(public_transport_conn[, ...])

Graph builder for the transit assignment Spiess & Florian algorithm.

lib_gtfs.GTFSRouteSystemBuilder(network, ...)

Utils#

create_delaunay_network.DelaunayAnalysis(project)

create_example

Parameters#

Parameters([project])

Global parameters module.