aequilibrae package#

Subpackages#

Submodules#

aequilibrae.context module#

aequilibrae.context.activate_project(project)#

aequilibrae.context.get_active_project(must_exist=True)#

aequilibrae.context.get_logger()#

aequilibrae.log module#

class aequilibrae.log.Log(project_base_path: str)#

Bases: object

API entry point to the log file contents

>>> from aequilibrae import Project

>>> project = Project.from_path("/tmp/test_project")

>>> log = project.log()

# We get all entries for the log file
>>> entries = log.contents()

# Or clear everything (NO UN-DOs)
>>> log.clear()

contents() → list#

Returns contents of log file

Return:: log_contents (list): List with all entries in the log file

clear()#: Clears the log file. Use it wisely

aequilibrae.log.get_log_handler(log_file: str, ensure_file_exists=True)#: Return a log handler that writes to the given log_file

aequilibrae.parameters module#

class aequilibrae.parameters.Parameters(project=None)#

Bases: object

Global parameters module

Parameters are used in many procedures, and are often defined only in the parameters.yml file ONLY Parameters are organized in the following groups:

assignment
distribution
system
report zeros
temp directory

>>> from aequilibrae import Project, Parameters

>>> project = Project.from_path("/tmp/test_project")

>>> p = Parameters(project)

>>> p.parameters['system']['logging_directory'] =  "/tmp/other_folder"
>>> p.parameters['osm']['overpass_endpoint'] = "http://192.168.0.110:32780/api"
>>> p.parameters['osm']['max_query_area_size'] = 10000000000
>>> p.parameters['osm']['sleeptime'] = 0
>>> p.write_back()

>>> # You can also restore the software default values
>>> p.restore_default()

file_default: str = '/opt/hostedtoolcache/Python/3.9.18/x64/lib/python3.9/site-packages/aequilibrae/parameters.yml'#

write_back()#: Writes the parameters back to file

restore_default()#: Restores parameters to generic default

Module contents#

aequilibrae.setup()#

aequilibrae.cleaning()#