Skip to content

Latest commit

 

History

History
110 lines (73 loc) · 4.73 KB

INSTALL.md

File metadata and controls

110 lines (73 loc) · 4.73 KB

Installation Guide

General Information

This project contains the code to take part in the tool competition. It is developed in Python and runs on Windows machines (we tested the code also by running Parallel Desktop on a Mac Book Pro).

Note: In the following, we assume the use of Windows PowerShell and that you have the rights of executing scripts with it.

Dependencies

BeamNG simulator

This tool needs the BeamNG simulator to be installed on the machine where it is running. A free version of the BeamNG simulator for research purposes can be obtained by registering at https://register.beamng.tech and following the instructions provided by BeamNG. Please fill the "Application Text" field of the registration form with the following text:

I would like to participate to the "Testing Self-Driving Car Software
Contest" of the SBST Tool Competition 2022 and for that I need to a
copy of BeamNG.tech

Note: as stated on the BeamNG registration page, please use your university email address. If you do not own a university email address, please contact the organizers of the tool competition.

For the competition we use BeamNG.tech v0.24.1, please make sure you download exactly this version of the simulator, i.e., file BeamNG.tech.v0.24.0.1.zip.

Installing BeamNG.tech is as simple as extracting the files to a target folder in your system (e.g., C:\BeamNG.tech.v0.24.0.1). We call this folder <BEAMNG_HOME>. Additionally, we suggest you create another folder (e.g., C:\BeamNG.tech.v0.24.0.1_userpath) that will act as BeamNG.tech working dir. BeamNG.tech will copy in this directory the levels and its cache. We call this folder <BEAMNG_USER>.

Please copy the tech.key file that you received after registering inside the <BEAMNG_USER> folder.

NOTE: Make sure that <BEAMNG_HOME> and <BEAMNG_USER> contain no spaces nor special characters.

Python

This code requires Python 3.7.

Other Libraries

To easily install the other dependencies with rely on pip, we suggest to create a dedicated virtual environment (we tested venv),activate it, and upgrade pip and basic packages:

<PYTHON_37_HOME>\python.exe -m venv .venv
.\.venv\Scripts\activate

py.exe -m pip install --upgrade pip
pip install wheel setuptools --upgrade

Next, install the dependencies of the code pipeline:

pip install -r requirements.txt

Otherwise, you can manually install each required library listed in the requirements.txt file.

Note: the version of Shapely should match your system (see below).

In case your test generator requires additional library, please store them into an additional requirement file to be submitted along with your code.

To create such a file you can run the following command from within your active virtual environment:

pip freeze > additional-requirements.txt

Otherwise, you can manually list the additional libraries your test generator need in the additional-requirements.txt file.

Note: the format of this file must follow the usual pip convention where the library name is followed by the target version number separated by ==, e.g., beamngpy==1.21.1

Shapely

You can obtain Shapely from here.

You should download the wheel file matching you Python version, i.e., download the file with cp37 in the name if you use Python 3.7. The wheel file should also match the architecture of your machine, i.e., you should install the file with either win32 or win_amd64 in the name.

After downloading the wheel file, you can install Shapely by running (in an active virtual environment) the following command:

pip install /path/to/shapely/file

Recommended Requirements

BeamNG recommends the following hardware requirements:

  • OS: Windows 10 64-Bit
  • CPU: AMD Ryzen 7 1700 3.0Ghz / Intel Core i7-6700 3.4Ghz (or better)
  • RAM: 16 GB RAM
  • GPU: AMD R9 290 / Nvidia GeForce GTX 970
  • DirectX: Version 11
  • Storage: 20 GB available space
  • Additional Notes: Recommended spec based on 1080p resolution. Installing game mods will increase required storage space. Gamepad recommended.

Note: BeamNG.tech can run also on Mac Book provided you boot them on Windows or use a system virtualization software like Parallel Desktop. In the past, others managed to run the pipeline on the Amazon Cloud using an appropriate AMI.

A porting to linux is expected in the near future, but we cannot guarantee it will be ready before the tool competition's deadline. You can track the following issue on GitHub about Linux porting.