Technical Reference

Please note that this document is automatically generated from docstring, and some of the docstrings are automatically written by ChatGPT. Thus, they are not completely perfect. This was prepared with the intention of “better than nothing.”

Modules

uxsim.uxsim

UXsim: Macroscopic/mesoscopic traffic flow simulator in a network.

uxsim.utils

General utilities for UXsim.

uxsim.analyzer

Analyzer for a UXsim simulation result.

uxsim.ResultGUIViewer.ResultGUIViewer

Interactive viewer for UXsim simulation results using PyQt5.

uxsim.TaxiHandler.TaxiHandler

A base class for handling the assignment of trip requests to taxis (or ridesourcing, ridehailing, ridesharing, robot-taxi, shared mobility, whatever).

uxsim.Utilities.Utilities

Submodule for general utilities.

Classes (essential)

uxsim.World

World (i.e., simulation environment).

uxsim.Node

Node in a network.

uxsim.Link

Link in a network.

uxsim.Vehicle

Vehicle or platoon in a network.

uxsim.RouteChoice

Class for computing shortest path for all vehicles.

uxsim.analyzer.Analyzer

Class for analyzing and visualizing a simulation result.

Classes (support)

uxsim.Route

Class for a route that store concective links.

uxsim.TaxiHandler.TaxiHandler

A base class for handling the assignment of trip requests to taxis (or ridesourcing, ridehailing, ridesharing, robot-taxi, shared mobility, whatever).

uxsim.TaxiHandler.TripRequest

A class representing a trip request (or travelers, passengers, cargo, etc.)

uxsim.OSMImporter.OSMImporter

OpenStreetMap importer using OSMnx.

uxsim.ResultGUIViewer.ResultGUIViewer

Interactive viewer for UXsim simulation results using PyQt5.