Installation Guide

Docker

The easiest way to use CityFlow is via docker.

docker pull cityflowproject/cityflow:latest

This will create docker image cityflow:latest.

docker run -it cityflowproject/cityflow:latest

Create and start a container, CityFlow is out-of-the-box along with miniconda with python3.6.

import cityflow
eng = cityflow.Engine

Build From Source

If you want to get nightly version of CityFlow or running on native system, you can build CityFlow from source. Currently, we only support building on Unix systems. This guide is based on Ubuntu 16.04.

CityFlow has little dependencies, so building from source is not scary.

  1. Check that you have python 3 installed. Other version of python might work, however, we only tested on python with version >= 3.5.
  2. Install cpp dependencies
sudo apt update && sudo apt install -y build-essential cmake
  1. Clone CityFlow project from github.
git clone https://github.com/cityflow-project/CityFlow.git
  1. Go to CityFlow project’s root directory and run
pip install .
  1. Wait for installation to complete and CityFlow should be successfully installed.
import cityflow
eng = cityflow.Engine

For Windows Users

For Windows users, it is recommended to run CityFlow under Windows Subsystem for Linux (WSL) or use docker.