CityGraph is a Python framework for representing a city (real or virtual) and moving around it.
The application only requires Python 3.5 or higher.
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.
To run the tests, simply do:
$ python -m unittest
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.
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
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.
© 2020, Max Planck Society / Software Workshop - Max Planck Institute for Intelligent Systems