aequilibrae.project.project#

Classes

Project()

AequilibraE project class
class aequilibrae.project.project.Project[source]#

AequilibraE project class

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

# Safely closes the project
>>> new_project.close()
Open Project#
>>> existing_project = Project()
>>> existing_project.open(project_path)

>>> existing_project.close()
activate()[source]#
check_file_indices() → None[source]#

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

clone_scenario(scenario_name: str, description: str = '')[source]#

Clones the active scenario.

Arguments:

scenario_name (str): scenario name

description (str): useful scenario description

close() → None[source]#

Safely closes the project

create_empty_scenario(scenario_name: str, description: str = '')[source]#

Creates an empty scenario, without any links, nodes, and zones.

Arguments:

scenario_name (str): scenario name

description (str): useful scenario description

deactivate()[source]#
classmethod from_path(project_folder)[source]#
list_scenarios()[source]#

Lists the existing scenarios.

Returns:

scenarios (pd.DataFrame): Pandas DataFrame with existing scenarios

log() → Log[source]#

Returns a log object

allows the user to read the log or clear it

new(project_path: str) → None[source]#

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[source]#

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()[source]#

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.

use_scenario(scenario_name: str)[source]#

Switch the active scenario.

Arguments:

scenario_name (str): name of the scenario to be activated

property about: About#
property db_connection#
property db_connection_spatial#
property logger: Logger#
property matrices: Matrices#
property network: Network#
property parameters: dict#
property path_to_file#
property project_base_path#
property project_parameters: Parameters#
property results: Results#
property results_connection#
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 transit: Transit#
property transit_connection#
property zoning#