gym-cityflow

gym_cityflow is a custom OpenAI gym environment designed to handle any CityFlow config file.

Prerequisites

1. OpenAI Gym
2. CityFlow

Installation

gym_cityflow can be installed by running the following at the root directory of the repository:

pip install -e .

gym_cityflow can then be used as a python library as follows:

Note: configPath must be a valid cityflow config.json file, episodeSteps is how many steps the environment will take before it is done

import gym
import gym_cityflow

env = gym.make(
    id='cityflow-v0', 
    configPath='sample_path/sample_config.json',
    episodeSteps=3600
)

Basic Functionality

The action and observation space can be checked like so:

observationSpace = env.observation_space
actionSpace = env.action_space

env.step() can be called to step the environment, it returns an observation, reward, done and debug as specified in the OpenAI Documentation

env.reset() can be called to restart the environment

observation, reward, done, debug = env.step(action=sampleAction)

if done:
    env.reset()