aequilibrae.project.About

class aequilibrae.project.About(project)

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)

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

create()

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

list_fields() → list

Returns a list of all characteristics the about table holds

add_info_field(info_field: str) → None

Adds new information field to the model

Arguments:

info_field (str): Name of the desired information field to be added. Has to be a valid Python VARIABLE name (i.e. letter as first character, no spaces and no special characters)

>>> from aequilibrae import Project

>>> p = Project.from_path("/tmp/test_project")
>>> p.about.add_info_field('a_cool_field')
>>> p.about.a_cool_field = 'super relevant information'
>>> p.about.write_back()

write_back()

Saves the information parameters back to the project database

>>> from aequilibrae import Project

>>> p = Project.from_path("/tmp/test_project")
>>> p.about.description = 'This is the example project. Do not use for forecast'
>>> p.about.write_back()