aequilibrae.Parameters#

class aequilibrae.Parameters(project=None)[source]#

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()
__init__(project=None)[source]#

Loads parameters from file. The place is always the same. The root of the package

Methods

__init__([project])

Loads parameters from file.

restore_default()

Restores parameters to generic default

write_back()

Writes the parameters back to file

Attributes

file_default