Skip to main content
`Ctrl`+`K`

# aequilibrae.Parameters

class aequilibrae.Parameters(project=None)

  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(project)

      >>> 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()

  __init__(project=None)

    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` |

  restore_default()

    Restores parameters to generic default

  write_back()

    Writes the parameters back to file

  file_default: str = '/opt/hostedtoolcache/Python/3.10.15/x64/lib/python3.10/site-packages/aequilibrae/parameters.yml'