uxsimpp¶
- uxsimpp.uxsimpp.addLink(W, name, start_node, end_node, length, free_flow_speed=20, jam_density=0.2, merge_priority=1, capacity_out=-1, signal_group=[0])[source]¶
Add a link to the world.
- Parameters:
W (World) – The world to which the link belongs.
name (str) – The name of the link.
start_node (str or Node) – The name of the start node of the link.
end_node (str or Node) – The name of the end node of the link.
length (float) – The length of the link.
free_flow_speed (float, optional) – The free flow speed on the link, default is 20.
jam_density (float, optional) – The jam density on the link, default is 0.2.
merge_priority (float, optional) – The priority of the link when merging, default is 1.
capacity_out (float, optional) – The capacity out of the link, default is -1 (unlimited).
signal_group (int or list, optional) – The signal group(s) to which the link belongs, default is [0].
- Returns:
The created link.
- Return type:
- uxsimpp.uxsimpp.addNode(W, name, x, y, signal_intervals=[0], signal_offset=0)[source]¶
Add a node to the world.
- Parameters:
W (World) – The world to which the node belongs.
name (str) – The name of the node.
x (float) – The x-coordinate of the node.
y (float) – The y-coordinate of the node.
signal_intervals (list of float, optional) – A list representing the signal at the node, default is [0].
signal_offset (float, optional) – The offset of the signal, default is 0.
- Returns:
The created node.
- Return type:
- uxsimpp.uxsimpp.adddemand(W, origin, destination, start_time, end_time, flow, links_preferred_list=[])[source]¶
Add demand (vehicle generation) to the world.
- Parameters:
W (World) – The world to which the demand belongs.
origin (str or Node) – The origin node.
destination (str or Node) – The destination node.
start_time (float) – The start time of demand.
end_time (float) – The end time of demand.
flow (float) – The flow rate of vehicles.
links_preferred_list (list of str or Link, optional) – The names of the links the vehicles prefer, default is empty list.
- uxsimpp.uxsimpp.eq_tol(val, check, rel_tol=0.1, abs_tol=0.0, print_mode=True)[source]¶
function for tests
- uxsimpp.uxsimpp.exec_simulation(W, duration_t=-1, until_t=-1)[source]¶
Execute the simulation.
- Parameters:
W (World) – The world simulation object.
duration_t (float, optional) – Duration to run simulation, default is -1 (until completion).
until_t (float, optional) – Time to run simulation until, default is -1 (until completion).
- uxsimpp.uxsimpp.newWorld(name='', tmax=3600, deltan=5, tau=1, duo_update_time=600, duo_update_weight=0.5, print_mode=True, random_seed=None, vehicle_detailed_log=1)[source]¶
Create a World (simulation environment).
- Parameters:
name (str, optional) – The name of the world, default is empty string.
tmax (float, optional) – The simulation duration, default is 3600 seconds.
deltan (int, optional) – The platoon size, default is 5 vehicles.
tau (float, optional) – The reaction time, default is 1 second.
duo_update_time (float, optional) – The time interval for route choice update, default is 600 seconds.
duo_update_weight (float, optional) – The update weight for route choice, default is 0.5.
print_mode (bool, optional) – Whether print the simulation progress or not, default is True.
random_seed (int or None, optional) – The random seed, default is None.
vehicle_detailed_log (int, optional) – Whether save vehicle data or not, default is 1.
- Returns:
World simulation object.
- Return type: