installation.rst

Installation

Software Runtime & Dependencies

This is the recommended way of installation and running flatland's dependencies.

• Install Anaconda by following the instructions here
• Create a new conda environment

$ conda create python=3.6 --name flatland-rl
$ conda activate flatland-rl

• Install the necessary dependencies

$ conda install -c conda-forge cairosvg pycairo
$ conda install -c anaconda tk

Stable release

To install flatland, run this command in your terminal:

$ pip install flatland-rl

This is the preferred method to install flatland, as it will always install the most recent stable release.

If you don't have pip installed, this Python installation guide can guide you through the process.

From sources

The sources for flatland can be downloaded from the Gitlab repo.

You can clone the public repository:

$ git clone git@gitlab.aicrowd.com:flatland/flatland.git

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

$ python setup.py install

Jupyter Canvas Widget

If you work with jupyter notebook you need to install the Jupyer Canvas Widget. To install the Jupyter Canvas Widget read also https://github.com/Who8MyLunch/Jupyter_Canvas_Widget#installation