CityGraph

CityGraph is a Python framework for representing a city (real or virtual) and moving around it.

Requirements

The application only requires Python 3.5 or higher.

Installation

CityGraph releases can be instaled from PyPI:

$ pip install city-graph

Alternatively, one can also clone the repository and install the package locally:

$ git clone https://github.com/MPI-IS/CityGraph.git
$ cd CityGraph
$ pip install .

We strongly advise to install the package in a dedicated virtual environment.

Tests

To run the tests, simply do:

$ python -m unittest

Documentation

To build the Sphinx documentation:

$ pip install sphinx sphinx-bootstrap-theme
$ cd doc
$ make html

and open the file build/html/index.html in your web browser.

Authors

Jean-Claude Passy, Software Workshop - Max Planck Institute for Intelligent Systems

Ivan Oreshnikov, Software Workshop - Max Planck Institute for Intelligent Systems

Vincent Berenz, Max Planck Institute for Intelligent Systems

License

BSD-3-Clause (see LICENSE.md).

The OSM import code contains a modified snippet of code from the project osmnx that is being distributed under the MIT License; for the original license file and copyright attribution see LICENSE_OSMNX.md.

MPI-IS/CityGraph