Setup Instructions#


This repository requires python v3.6 or v3.7 as the flatland-rl module depends on it.

Install from PyPi#


Not released on PyPi yet, this section will be updated after the release.

Install from source#

$ pip install git+

Install using a local clone of the source#

The Analysis Framework code source is available on gitlab.

Clone the public repository:

$ git clone
$ cd flatland-analysis/

Once you have a copy of the source, install it with:

$ pip install -e ./

Test Installation#

Once its done installing, test it by running the following code in a python interpreter:

$ python
Python 3.7.10 (default, Feb 26 2021, 13:06:18) [MSC v.1916 64 bit (AMD64)] :: Anaconda, Inc. on win32
Type "help", "copyright", "credits" or "license" for more information.
>>> from flatland_analysis.metrics import DummyMetric
>>> metric = DummyMetric()
>>> metric()