Technical Reference¶
This page summarizes the detailed specifications of the modules, classes, and their functions in UXsim. This is highly technical; for the basic introduction, please see the getting started page and mechanism page first.
Classes (essential)¶
These classes are essential for UXsim.
World is the simulation environment and accessed by users directly.
Node, Link, and Vehicle objects should be added to a World object by World.addNode, World.addLink, World.adddemand methods, and access to them is provided by World.
Thus, for basic usage, users do not need to access them directly.
RouteChoice is for vehicles’ route choice behaviors, and basically it is not required to be directly accessed by users.
Analyzer is for analysis of simulation results and it is basically accessible as World.analyzer.
World (i.e., simulation environment). |
|
Node in a network. |
|
Link in a network. |
|
Vehicle or platoon in a network. |
|
Class for computing shortest path for all vehicles. |
|
Class for analyzing and visualizing a simulation result. |
Classes (support)¶
These classes are not necessary for the basic usage of UXsim, but useful for specific or advanced analyses.
DTAsolvers can be used to derive approximate solutions for Dynamic User Equilibrium (DUE) and Dynamic System Optimum (DSO).
TaxiHandler can be used to simulate shared mobility.
OSMImporter2 is for importing OpenStreetMap data.
Class for a route that stores consecutive links. |
|
Solve quasi Dynamic User Equilibrium (DUE) problem using day-to-day dynamics. |
|
Solve quasi Dynamic System Optimum (DSO) problem using day-to-day dynamics. |
|
A class representing a trip request (or travelers, passengers, cargo, etc.). |
|
A base class for handling the assignment of trip requests to taxis (or ridesourcing, ridehailing, ridesharing, robot-taxi, shared mobility, whatever). |
|
A taxi handler that assigns trip requests to nearest taxis (based on Euclidean distance). |
|
OpenStreetMap importer using OSMnx and neatnet. |
|
Interactive viewer for UXsim simulation results using PyQt5. |
Modules¶
These are the module and sub-module of UXsim.
For basic usage, only uxsim is required to imported.
analyzer, utils, and scenario_reader_writer are automatically imported along with uxsim, and access to them is provided by classes in uxsim.
analyzer is for analysis of simulation results and it is basically accessible via World.analyzer.
For utils and scenario_reader_writer, users will not use them directly.
The other sub-modules may be useful for specific or advanced analyses.
UXsim: Macroscopic/mesoscopic traffic flow simulator in a network. |
|
General utilities for UXsim. |
|
Analyzer for a UXsim simulation result. |
|
Scenario reader and writer using toml. |
|
Interactive viewer for UXsim simulation results using PyQt5. |
|
A base class for handling the assignment of trip requests to taxis (or ridesourcing, ridehailing, ridesharing, robot-taxi, shared mobility, whatever). |
|
Submodule for general utilities. |