aequilibrae.project.About#

class aequilibrae.project.About(project)[source]#

Provides an interface for querying and editing the about table of an AequilibraE project

>>> from aequilibrae import Project

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

# Adding a new field and saving it
>>> project.about.add_info_field('my_super_relevant_field')
>>> project.about.my_super_relevant_field = 'super relevant information'
>>> project.about.write_back()

# changing the value for an existing value/field
>>> project.about.scenario_name = 'Just a better scenario name'
>>> project.about.write_back()
__init__(project)[source]#

Methods

__init__(project)

add_info_field(info_field)

Adds new information field to the model

create()

Creates the 'about' table for project files that did not previously contain it

list_fields()

Returns a list of all characteristics the about table holds

write_back()

Saves the information parameters back to the project database