Skip to main content

Tutorials Documentation License PyPI Version Publication Python 3.9–3.13 Open in Code Ocean

Welcome to the future of urban routing.

Multi-agent reinforcement learning framework for modeling and simulating the collective route choices of humans and autonomous vehicles.


RouteRL is a multi-agent reinforcement learning framework that integrates RL-based collective route choice with a microscopic traffic simulation, SUMO, facilitating the testing and development of efficient route choice strategies. The proposed framework simulates the daily route choices of driver agents in a city, including two types:

  • human drivers, emulated using discrete choice models,
  • and AVs, modeled as MARL agents optimizing their policies for a predefined objective.

RouteRL aims to advance research in MARL, traffic assignment problems, social reinforcement learning, and human-AI interaction for transportation applications.

  • The main class is TrafficEnvironment and is a PettingZoo AEC API environment.
  • There are two types of agents in the environment and are both represented by the BaseAgent class.
    • Human drivers are simulated using human route-choice behavior from transportation research.
    • Automated vehicles (AVs) are the RL agents that aim to optimize their routes and learn the most efficient paths.
  • RouteRL is compatible with popular RL libraries such as TorchRL.

For overview see the paper and for more details, check the documentation online.

RouteRL usage and functionalities at a glance

The following is a simplified code of a possible standard MARL algorithm implementation via TorchRL.

env = TrafficEnvironment(seed=42, **env_params) # initialize the traffic environment

env.start() # start the connection with SUMO

for episode in range(human_learning_episodes): # human learning 
    env.step()

env.mutation() # some human agents transition to AV agents

collector = SyncDataCollector(env, policy, ...)  # collects experience by running the policy in the environment (TorchRL)

# training of the autonomous vehicles; human agents follow fixed decisions learned in their learning phase
for tensordict_data in collector:
        
    # update the policies of the learning agents
    for _ in range(num_epochs):
      subdata = replay_buffer.sample()
      loss_vals = loss_module(subdata)

      optimizer.step()
    collector.update_policy_weights_()

policy.eval() # set the policy into evaluation mode

# testing phase using the already trained policy
num_episodes = 100
for episode in range(num_episodes):
    env.rollout(len(env.machine_agents), policy=policy)
 
env.plot_results() # plot the results
env.stop_simulation() # stop the connection with SUMO

Documentation

Installation

  • Prerequisite: Make sure you have SUMO installed in your system. This procedure should be carried out separately, by following the instructions provided here.
  • Option 1: Install the latest stable version from PyPI:
      pip install routerl
    
  • Option 2: Clone this repository for latest version, and manually install its dependencies:
      git clone https://github.com/COeXISTENCE-PROJECT/RouteRL.git
      cd RouteRL
      pip install -r requirements.txt
    

Reproducibility capsule

We have an experiment script encapsulated in a CodeOcean capsule. This capsule allows demonstrating RouteRL's capabilities without the need for SUMO installation or dependency management.

  1. Visit the capsule link.
  2. Create a free CodeOcean account (if you don’t have one).
  3. Click Reproducible Run to execute the code in a controlled and reproducible environment.

Citation

If you use RouteRL in your research, please cite the following paper:

@article{routerl,
  title = {RouteRL: Multi-agent reinforcement learning framework for urban route choice with autonomous vehicles},
  journal = {SoftwareX},
  volume = {31},
  pages = {102279},
  year = {2025},
  issn = {2352-7110},
  doi = {https://doi.org/10.1016/j.softx.2025.102279},
  url = {https://www.sciencedirect.com/science/article/pii/S2352711025002468},
  author = {Ahmet Onur Akman and Anastasia Psarou and Łukasz Gorczyca and Zoltán György Varga and Grzegorz Jamróz and Rafał Kucharski}
}

Credits

RouteRL is part of COeXISTENCE (ERC Starting Grant, grant agreement No 101075838) and is a team work at Jagiellonian University in Kraków, Poland by: Ahmet Onur Akman and Anastasia Psarou (main contributors) supported by Grzegorz Jamroz, Zoltán Varga, Łukasz Gorczyca, Michał Hoffmann, Błażej Torbus, Mikołaj Rams and others, within the research group of Rafał Kucharski.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

routerl-2.0.0.tar.gz (2.3 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

routerl-2.0.0-py3-none-any.whl (2.4 MB view details)

Uploaded Python 3

File details

Details for the file routerl-2.0.0.tar.gz.

File metadata

  • Download URL: routerl-2.0.0.tar.gz
  • Upload date:
  • Size: 2.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.7

File hashes

Hashes for routerl-2.0.0.tar.gz
Algorithm Hash digest
SHA256 290ca8af68f37471abf45a32b727de0b8fde5db69d4a846f77275647970bf69f
MD5 45758c3d72ec0c63f739adb569cf4a35
BLAKE2b-256 f5db774342528f1f39ce4d3b0ea268e218ee934132ef4432b98286f8c4d7309e

See more details on using hashes here.

File details

Details for the file routerl-2.0.0-py3-none-any.whl.

File metadata

  • Download URL: routerl-2.0.0-py3-none-any.whl
  • Upload date:
  • Size: 2.4 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.7

File hashes

Hashes for routerl-2.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3a5af3cca5e2c5081f0d9145fb9db8e8a0ebca1ac42b359618d50a4212f7e85b
MD5 bf2b2b45957775d16e00ce665ba9bfae
BLAKE2b-256 b55706c713e3fb59a0824431ae00a94d4edab4c2523bc1f8f09f94ebf645b6a0

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

2.0.0 This release

2 files

1.0.1

2 files

1.0.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page