aequilibrae.project.Project

class aequilibrae.project.Project

AequilibraE project class

Create Project

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

Open Project

>>> existing_project = Project()
>>> existing_project.open(project_path)

__init__()

Methods

__init__()
activate()
check_file_indices()	Makes results_database.sqlite and the matrices folder compatible with project database
close()	Safely closes the project
deactivate()
from_path(project_folder)
log()	Returns a log object
new(project_path)	Creates a new project
open(project_path)	Loads project from disk
upgrade()	Find and apply all applicable migrations.

Attributes

db_connection
parameters
project_parameters
run	Load and return the AequilibraE run module with the default arguments from parameters.yml partially applied.
zoning

activate()

check_file_indices() → None

Makes results_database.sqlite and the matrices folder compatible with project database

close() → None

Safely closes the project

deactivate()

classmethod from_path(project_folder)

log() → Log

Returns a log object

allows the user to read the log or clear it

new(project_path: str) → None

Creates a new project

Arguments:

project_path (str): Full path to the project data folder. If folder exists, it will fail

open(project_path: str) → None

Loads project from disk

Arguments:

project_path (str): Full path to the project data folder. If the project inside does not exist, it will fail.

upgrade()

Find and apply all applicable migrations.

All database upgrades are applied within a single transaction.

If skipping a specific migration is required, use the aequilbrae.project.tools.MigrationManager object directly. Consult it’s documentation page for details. Take care when skipping migrations.

property db_connection

property parameters: dict

property project_parameters: Parameters

property run

Load and return the AequilibraE run module with the default arguments from parameters.yml partially applied.

Refer to run/__init__.py file within the project folder for documentation.

property zoning