Install

From pip

If you don’t plan to change the source code and just want to use the package as is: .. parsed-literal:

pip install gym_collision_avoidance

From source

Grab the code from github, initialize submodules, install dependencies and src code:

git clone --recursive git@github.com:mit-acl/gym-collision-avoidance.git # If internal to MIT-ACL, use GitLab origin instead
cd gym-collision-avoidance
./install.sh

You should be all set to move onto Minimum working example!


Common Issues

Issue:

RuntimeError: Python is not installed as a framework. The Mac OS X backend will not be able to function correctly if Python is not installed as a framework.

Fix: Add a line backend: TkAgg to ~/.matplotlib/matplotlibrc.


Issue:

error: Cannot compile MPI programs. Check your configuration!!!

Fix:

brew install mpich

Issue:

error with matplotlib and freetype not being found

Fix:

brew install pkg-config

Issue:

To update the Python-RVO2 source code and re-generate the rvo2 python library, the results won’t have any effect unless you remove the build dir:

# enter the venv
cd gym-collision-avoidance/gym_collision_avoidance/envs/policies/Python-RVO2
rm -rf build && python setup.py build && python setup.py install