aequilibrae.utils package

Submodules

aequilibrae.utils.create_delaunay_network module

class aequilibrae.utils.create_delaunay_network.DelaunayAnalysis(project)

Bases: object

__init__(project)

Start a Delaunay analysis

Args:

project (Project): The Project to connect to

create_network(source='zones', overwrite=False)

Creates a delaunay network based on the existing model

Args:

source (str, optional): Source of the centroids/zones. Either zones or network. Default zones

overwrite path (bool, optional): Whether to should overwrite an existing Delaunay Network. Default False

assign_matrix(matrix: AequilibraeMatrix, result_name: str)

aequilibrae.utils.create_example module

aequilibrae.utils.create_example.create_example(path: str, from_model='sioux_falls') → Project

Copies an example model to a new project project and returns the project handle

Args:

path (str): Path where to create a new model. must be a non-existing folder/directory. from_model path (str, Optional): Example to create from sioux_falls or nauru. Defaults to sioux_falls

Returns:

project (Project): Aequilibrae Project handle (open)

aequilibrae.utils.db_utils module

aequilibrae.utils.db_utils.list_tables_in_db(conn: Connection)
aequilibrae.utils.db_utils.safe_connect(filepath: PathLike, missing_ok=False)
aequilibrae.utils.db_utils.normalise_conn(curr: Cursor | Connection | PathLike)
class aequilibrae.utils.db_utils.commit_and_close(db: str | Path | Connection, commit: bool = True, missing_ok: bool = False)

Bases: object

A context manager for sqlite connections which closes and commits.

__init__(db: str | Path | Connection, commit: bool = True, missing_ok: bool = False)
Parameters:

  • db – The database (filename or connection) to be managed

  • commit (bool) – Boolean indicating if a commit/rollback should be attempted on closing

  • missing_ok (bool) – Boolean indicating that the db is not expected to exist yet

aequilibrae.utils.db_utils.read_and_close(filepath)

A context manager for sqlite connections (alias for commit_and_close(db,commit=False)).

aequilibrae.utils.db_utils.read_sql(sql, filepath, **kwargs)
aequilibrae.utils.db_utils.has_table(conn, table_name)
class aequilibrae.utils.db_utils.ColumnDef(idx: int, name: str, type: str, not_null: bool, default: str, is_pk: bool)

Bases: object

idx: int
name: str
type: str
not_null: bool
default: str
is_pk: bool
__init__(idx: int, name: str, type: str, not_null: bool, default: str, is_pk: bool) → None
aequilibrae.utils.db_utils.get_schema(conn, table_name)
aequilibrae.utils.db_utils.has_column(conn, table_name, col_name)
aequilibrae.utils.db_utils.add_column_unless_exists(conn, table_name, col_name, col_type, constraints=None)
aequilibrae.utils.db_utils.add_column(conn, table_name, col_name, col_type, constraints=None)

aequilibrae.utils.qgis_utils module

aequilibrae.utils.spatialite_utils module

aequilibrae.utils.spatialite_utils.is_windows()
aequilibrae.utils.spatialite_utils.is_not_windows()
aequilibrae.utils.spatialite_utils.connect_spatialite(path_to_file: PathLike, missing_ok: bool = False) → Connection
aequilibrae.utils.spatialite_utils.is_spatialite(conn)
aequilibrae.utils.spatialite_utils.ensure_spatialite_binaries(directory: PathLike | None = None) → None
aequilibrae.utils.spatialite_utils.spatialize_db(conn, logger=None)

aequilibrae.utils.worker_thread module

Original Author: UNKNOWN. COPIED FROM STACKOVERFLOW BUT CAN’T REMEMBER EXACTLY WHERE

class aequilibrae.utils.worker_thread.WorkerThread(parentThread)

Bases: QThread

jobFinished
__init__(parentThread)
run(self)
stop()
doWork()
cleanUp()

Module contents