aequilibrae.project.Project#

class aequilibrae.project.Project[source]#

AequilibraE project class

Create Project#
>>> newfile = Project()
>>> newfile.new('/tmp/new_project')
Open Project#
>>> from aequilibrae.project import Project

>>> existing = Project()
>>> existing.open('/tmp/test_project')

>>> #Let's check some of the project's properties
>>> existing.network.list_modes()
['M', 'T', 'b', 'c', 't', 'w']
>>> existing.network.count_links()
76
>>> existing.network.count_nodes()
24
__init__()[source]#

Methods

__init__()

activate()

check_file_indices()

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

close()

Safely closes the project

connect()

deactivate()

from_path(project_folder)

load(project_path)

Loads project from disk

log()

Returns a log object

new(project_path)

Creates a new project

open(project_path)

Loads project from disk

Attributes

parameters

project_parameters

zoning

classmethod from_path(project_folder)[source]#
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.

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

close() None[source]#

Safely closes the project

load(project_path: str) None[source]#

Loads project from disk

Deprecated since version 0.7.0: Use open() instead.

Arguments:

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

connect()[source]#
activate()[source]#
deactivate()[source]#
log() Log[source]#

Returns a log object

allows the user to read the log or clear it

property project_parameters: Parameters#
property parameters: dict#
check_file_indices() None[source]#

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

property zoning#