using_binaries.md

Using ADRL Binaries

Linux

• Downloading

  • Use the download_linux_binaries.sh script.
  • Python client:
    pip install airsimdroneracinglab

• Running

  • Running in windowed mode:

    ./ADRL/ADRL.sh -windowed
    

  • Running headless (with rendering of images enabled):

    DISPLAY= ./ADRL/ADRL.sh
    

  • For more command line options, see here.

Windows

• Downloading

  • Go to the release tab.

  • Download ADRL.zip from the latest windows release, and unzip it.

  • Download and move the settings.json file to ~/Documents/AirSim/settings.json.

  • Python client:
    pip install airsimdroneracinglab

• Running

  • Navigate to the ADRL/ directory, and double-click run.bat (or ADRL.exe -windowed)
  • For more command line options, see here.

Command Line Options

The following command line options are provided by Unreal Engine, and work in Linux and Windows both.
Here's a complete list of possible command line arguments.

• To disable rendering completely for training planning and / or control policies, you can use:

  ./ADRL/ADRL.sh -nullrhi
  

  Note that simGetImages will not work with this option.

• To increase speed of simGetImages:

  • Add "ViewMode": "NoDisplay" to your ~/Documents/AirSim/settings.json file, or replace its contents with this file.
    This disables rendering in the main viewport camera.
    Then run the binary with the following options.

  ./AirSimDroneRacingLab.sh -windowed -NoVSync -BENCHMARK
  

  • You can use Unreal Engine's Stat commands Stat FPS, Stat UnitGraph, r.VSync, t.maxFPS for monitoring performance.