aequilibrae.parameters#

Classes

Parameters([path])

Global parameters module.
class aequilibrae.parameters.Parameters(path: Path | None = None)[source]#

Global parameters module.

Parameters are used in many procedures, and are often defined in the parameters.yml file ONLY.

Parameters are organized in the following groups:

  • assignment

  • distribution

  • network * links * modes * nodes * osm * gmns

  • osm

  • system

Please observe that OSM information handled on network is not the same on the OSM group.

>>> from aequilibrae import Parameters

>>> project = Project()
>>> project.new(project_path)

>>> p = Parameters()

>>> p.parameters['system']['logging_directory'] =  "/path_to/other_logging_directory"
>>> 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()

>>> project.close()
restore_default()[source]#

Restores parameters to generic default

write_back()[source]#

Writes the parameters back to file

file_default: str = '/home/runner/work/aequilibrae/aequilibrae/aequilibrae/parameters.yml'#