aequilibrae.paths package

Submodules

aequilibrae.paths.AoN module

aequilibrae.paths.all_or_nothing module

aequilibrae.paths.basic_path_finding module

aequilibrae.paths.graph module

class aequilibrae.paths.graph.Graph

Bases: object

Graph class

add_single_field(new_field)
available_skims()
build_derived_properties()
create_from_geography(geo_file: str, id_field: str, dir_field: str, cost_field: str, centroids: numpy.ndarray, skim_fields=[], anode='A_NODE', bnode='B_NODE') → None
Parameters

  • geo_file (str) – Path to the geographic file to be used. File is usually the output of the network preparation tool from the AequilibraE plugin for QGIS

  • id_field (str) – Name of the field that has link IDs (must be unique)

  • dir_field (str) – Name of the field that has the link directions of flow ([-1, 0, 1])

  • cost_field (str) – Name of the field that has the cost data (field to minimized in shortest para)

  • centroids (ndarray) – Numpy Array with a list of centroids included in this graph

  • skim_fields – List with the name of fields to be skimmed

  • anode (str) – Name of the field with information of A_Node of links (if different than A_NODE)

  • bnode (str) – Name of the field with information of B_Node of links (if different than B_NODE)

default_types(tp: str)
load_from_disk(filename)
prepare_graph(centroids: numpy.ndarray) → None
Parameters

centroids (ndarray) – Array with centroid IDs. Mandatory type Int64, unique and positive

reset_single_fields()
save_to_disk(filename)
set_blocked_centroid_flows(blocking)
set_graph(cost_field, block_centroid_flows=True) → None
set_skimming(skim_fields: list) → None

aequilibrae.paths.multi_threaded_aon module

class aequilibrae.paths.multi_threaded_aon.MultiThreadedAoN

Bases: object

prepare(graph, results)

aequilibrae.paths.multi_threaded_skimming module

class aequilibrae.paths.multi_threaded_skimming.MultiThreadedNetworkSkimming

Bases: object

prepare(graph, results)

aequilibrae.paths.network_skimming module

aequilibrae.paths.setup_Assignment module

Module contents

path computation related code