metrosim/docs/architecture/overview/general_architecture.rst

37 lines
1.2 KiB
ReStructuredText

General Architecture
====================
System Context
--------------
The following diagram shows how MetroSim is integrated in the Metropolis system.
MetroSim is supposed to be installed on servers.
Most users only interact with MetroSim through the web interface MetroWeb.
Only developers can install, run and modify MetroSim directly from their computers.
The present documentation is dedicated to the simulator MetroSim.
.. uml:: metrosim_system_context.puml
:caption: Metrosim System Context
:width: 100 %
:align: center
Container Diagram
-----------------
The following diagram shows that MetroSim can be divided in two main parts:
- The Initializer that can run multiple scripts to, e.g., generate the population, pre-process the network, compute attractive public-transit paths.
- The Simulator that iteratively computes and executes the choices of the agents.
The Input data required by MetroSim are written in CSV and JSON files.
The Output data are also CSV and JSON files.
The web interface can communicate with MetroSim by writing the Input files and reading the Output files.
.. uml:: metrosim_container.puml
:caption: MetroSim Container Diagram
:width: 100 %
:align: center