.. MetroSim documentation master file, created by
   sphinx-quickstart on Wed Feb 10 16:14:39 2021.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

MetroSim, the simulator for Metropolis: Developer Documentation
================================================================

MetroSim is a dynamic traffic-assignment simulator, developed for Metropolis.

MetroSim simulates the mode choice, departure-time choice and route choice of commuters in large-scale scenarios.
MetroSim can be used in conjunction with the MetroWeb interface or as a standalone program (for debugging and development purposes).

The present documentation describes precisely how MetroSim works.
It is intended at developers willing to improve or extend it.

.. toctree::
   :caption: Getting Started
   
   /getting-started/introduction
   /getting-started/installation
   /getting-started/quickstart
   /getting-started/glossary


.. toctree::
   :caption: Architecture
   :maxdepth: 2

   /architecture/overview/overview
   /architecture/initializer
   /architecture/simulator/simulator
   /architecture/road_network/road_network

.. toctree::
   :caption: References

   /references/changelog

.. toctree::
   :caption: Contributing

   /contributing/building
   /contributing/versioning