jodeln package

jodeln.main module

class jodeln.main.MainWindow

Bases: QMainWindow

Main window presented to the user when the program first starts.

estimate_od() → None

Run OD matrix estimation.

Export links and turns along each OD pair.

export_routes() → None

Export nodes on each route.

export_turns() → None

Export turns to csv.

load() → None

Load nodes, links, etc from user inputs.

on_od_table_selection(selected, deselected) → None

Function called when an item in the OD Table is selected.

Parameters

  • selected (QItemSelection) – Currently selected item from the selectionModel.

  • deselected (QItemSelection) – Items from the selectionModel that were previously selected, but are no longer selected.

on_pbExportFolder_click() → None

Open a standard file dialog for selecting the export folder.

show_dialog_open() → None
staticMetaObject = <PySide2.QtCore.QMetaObject object>

jodeln.model module

Model component of the Model-View-Controller (MVC) design pattern for Jodeln.

class jodeln.model.Model

Bases: object

Contains the network and od data, and methods to operate on them.

These methods are the API for a view/controller to interact with the data.

estimate_od(weight_total_geh=None, weight_odsse=None, weight_route_ratio=None)

Estimate an OD matrix that attempts to meet various network volume targets.

By default the ODME objective function weights are None. Passing None allows odme.estimate_od function to set the default objective function weights.

Parameters

  • weight_total_geh (float, optional) – Objective function weight of the sum of all GEH values in the network.

  • weight_odsse (float, optional) – Objective function weight for the influence of the seed matrix. Higher weight means the estimated matrix should have values close to the seed matrix, even if that means sacrificing link and turn GEH.

  • weight_route_ratio (float, optional) – Objective function weight of the OD route ratios.

Returns

List of the final values of the ODME objective function variables.

Return type

List[float]

export_node_sequence(output_folder=None) → None

Write the links and turns on every OD route to csv.

export_od(output_folder=None) → None

Write estimated OD to csv.

export_od_by_route(output_folder=None) → None

Write estimated OD to csv, in list format, one row per OD pair.

export_route_list(output_folder=None) → None

Export the nodes along each route. One row per route.

export_turns(output_folder=None) → None

Write turns to csv.

Return node ids for the start and end of each link.

get_node_xy()

Return xy coordinates for each node.

get_route_list()

Return basic OD information for each route.

load(node_file=None, links_file=None, od_seed_file=None, turns_file=None, od_routes_file=None) → None

Populate network and od variables with user supplied data.

Parameters

  • node_file (str, optional) – File path to Network nodes, by default None.

  • links_file (str, optional) – File path to Network links, by default None.

  • od_seed_file (str , optional) – File path to seed matrix, by default None.

  • turns_file (str, optional) – File path to turn targets, by default None.

  • od_routes_file (str, optional) – File path to OD routes, by default None.

Returns

True if load was successful, otherwise False.

Return type

bool

net
od_seed

Seed OD matrix loaded from csv.

Type

dict

class jodeln.model.RouteInfo(origin: int, destination: int, o_name: str, d_name: str, name: str, nodes: List)

Bases: object

Basic OD information for a route.

d_name: str
destination: int
name: str
nodes: List
o_name: str
origin: int

Subpackages