6.1.2.4. aequilibrae.project.Matrices

class aequilibrae.project.Matrices

Bases: object

Gateway into the matrices available/recorded in the model

__init__()

Initialize self. See help(type(self)) for accurate signature.

Methods

__init__()

Initialize self.

check_exists(name)

Checks whether a matrix with a given name exists

clear_database()

Removes records from the matrices database that do not exist in disk

delete_record(matrix_name)

Deletes a Matrix Record from the model and attempts to remove from disk

get_matrix(matrix_name)

Returns an AequilibraE matrix available in the project

get_record(matrix_name)

Returns a model Matrix Record for manipulation in memory

list()

List of all matrices available Returns: df (pd.DataFrame:) Pandas DataFrame listing all matrices available in the model

new_record(name, file_name[, matrix])

Creates a new record for a matrix in disk, but does not save it

reload()

Discards all memory matrices in memory and loads recreate them

update_database()

Adds records to the matrices database for matrix files found on disk

__init__()

Initialize self. See help(type(self)) for accurate signature.