Skip to content

Latest commit

 

History

History
86 lines (60 loc) · 3.69 KB

installation.md

File metadata and controls

86 lines (60 loc) · 3.69 KB
Raw

How to Install BARK

This section describes the prerequisites and installation-steps of BARK.

Prerequisites

  • Bazel > 3(requires Java)
  • Python3.7 (sudo apt-get install python3.7 python3.7-dev python3.7-tk)
  • Virtual Env (pip3 install virtualenv==16.7.8) (note that the newest version does not seem to link the Python.h)
  • gcc7 (needs to be set as the default compiler)
  • Visual Studio Code

Using ad-rss-lib

  • sqlite 3 (sudo apt-get install libsqlite3-dev sqlite3)

Install using pip

  • pip3 install bark-simulator

Setup on Linux

We recommend to use an anaconda environment instead of your system's python installation. Otherwise, you can proceed with step 5.

  1. Install Anaconda: see https://docs.anaconda.com/anaconda/install/linux/ for more information
  2. Install Conda Environment with Python 3.7: conda create -n bark_env python=3.7
  3. Activate the new environment: conda activate bark_env
  4. Install Virtual Env: pip3 install virtualenv==16.7.8
  5. Use git clone https://github.com/bark-simulator/bark.git or download the repository from this page.
  6. Change directory to bark
  7. Run bash install.sh: creates a virtual environment (located in python/venv) and installs all python packages
  8. Run source dev_into.sh: activates the virtual environment (make sure to run this before bazel)
  9. Use bazel test //... to validate that BARK is working.
  10. Finally, try one of the examples provided in BARK by running bazel run //bark/examples:merging.

Setup on MacOS

  1. Install pyenv: brew install pyenv.
  2. Install a newer version of tcl-tk: brew upgrade tcl-tk.
  3. Run pyenv install python3.7-dev. If you run into trouble with TKInter have a look here.
  4. Set this as your global Python version: pyenv global 3.7-dev.
  5. Also add this Python version to your ~/.zshrc by adding eval "$(pyenv init -)".
  6. Install an older version of the virtualenv package by running: pip install virtualenv==16.7.8
  7. In order to set TKAgg as backend have a look here.
  8. Modify the file install.sh by using virtualenv -p python ./python/venv instead as python is now the pyenv version.
  9. Now you can follow the same steps as when using Linux.

Build Pip package

  • Install twine using python3 -m pip install --user --upgrade twine
  • Run script bash package.sh to build code, package and upload to pypi

Frequently Asked Questions (FAQs)

Python.h not found

Make sure that there is a 'Python.h' file in the python/venv folder.

GCC: Interal Compiler Error: Killed (program cc1plus)

You might be running out of memory during the bazel build. Try limiting the memory available to bark via bazel build //... --local_ram_resources=HOST_RAM*.4 (or any other build or test call).

Feel free to add your questions here or asks us directly by submitting an issue!

Run examples

Once you activated the virtual environment (source dev_into.sh), you can explore some examples of BARK.

Highway: ' bazel run //bark/examples:highway:

BARK

Merging: bazel run //bark/examples:merging:

BARK

Intersection: bazel run //bark/examples:intersection:

BARK