Mercury’s documentation¶

Welcome to the documentation of the open source mobility simulator Mercury. This documentation is a work in progress. If you need information, you can check the readme file or contact the University of Westminster ATM team.

Contents:

  • Overview
    • What is Mercury?
    • Quick FAQ
  • Table of Contents
  • Quickstart
    • Docker
    • Installation
    • Running the CLI version
    • Programmatic use of Mercury
    • Graphical interface
  • Basic usage
    • Installation
    • How to run Mercury
    • Data Input
    • Data Output
    • Command Line Interface
    • Programmatic use
    • GUI
  • Advanced usage
    • Parametriser and Aggregator
    • Modules
    • External messaging system
    • Door-to-door extension
  • Input/Output specifications
    • Simulation parameters
    • Scenario parameters
    • Input table specifications
    • Output table specifications
  • API
  • Software Architecture
  • About
    • Authorship
    • Licence and copyright

Indices and tables¶

  • Index

  • Module Index

  • Search Page

Logo

An open source mobility simulator

Navigation

Contents:

  • Overview
  • Table of Contents
  • Quickstart
  • Basic usage
  • Advanced usage
  • Input/Output specifications
  • API
  • Software Architecture
  • About

Related Topics

  • Documentation overview
    • Next: Overview
©2023, University of Westminster, Innaxis, Luis Delgado, Gerald Gurtner. | Powered by Sphinx 8.1.3 & Alabaster 1.0.0 | Page source
Fork me on GitHub