.. UXsim documentation master file, created by
   sphinx-quickstart on Wed Oct 11 14:27:43 2023.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

UXsim: Traffic simulation in Python
===================================

About
-----

UXsim is an open-source macroscopic and mesoscopic network traffic flow simulator developed in Python. 
This webpage is a technical documentation of UXsim codes.
Please visit `Github repo <https://github.com/toruseo/UXsim>`_ first. 

Example
-------
Belows are simulation result where approximately 60000 vehicles pass through a 10km x 10km grid network in 2 hours. The computation time was about 30 seconds on a standard desktop PC. 
The first animation shows link congestion level and the second shows sampled vehicle trajectories.

.. image:: https://raw.githubusercontent.com/toruseo/UXsim/images/gridnetwork_macro.gif
    :width: 45%

.. image:: https://raw.githubusercontent.com/toruseo/UXsim/images/gridnetwork_fancy.gif
    :width: 45%


Contents
========

.. toctree::
   :maxdepth: 2

   getting_started
   tutorial
   mechanism
   tech_ref

Links
=====

* `Github repo of UXsim <https://github.com/toruseo/UXsim>`_
* `arXiv preprint on UXsim <https://arxiv.org/pdf/2309.17114.pdf>`_
* `Author (Toru Seo) <https://toruseo.jp/index_en.html>`_