Skip to main content

The BenchBot API for use with the ACRV Scene Understanding Challenge

Project description

BenchBot API

The BenchBot API provides a simple interface for controlling and receiving data from a robot or simulator. Open AI Gym users will find the BenchBot API extremely familiar. By taking the hassle out of interfacing with complicated robot systems, you can focus instead on developing and testing your novel algorithms with real robot systems and realistic 3D simulators.

BenchBot is used as part of the ACRV Scene Understanding Challenge. For further details of the challenge see: [] (

Getting started with a robot using BenchBot is as simple as:

from benchbot_api.benchbot import BenchBot

benchbot = BenchBot() # Create a benchbot instance

action_list = benchbot.actions  # Get a list of available actions
observation_list = benchbot.get('command') # Get a list of observations

# Perform an action, & get observations, reward, info from performing the
# action
observations, reward, info = benchbot.step(action_list[0])

For full examples of solutions that use the BenchBot API, see the benchbot_examples repository.


Use pip to install BenchBot API & dependencies (from inside this repository's root directory):

pip install .

To get the latest published version without cloning this repository, simply:

pip install benchbot_api

Project details

Release history Release notifications

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for benchbot-api, version 0.1.3
Filename, size File type Python version Upload date Hashes
Filename, size benchbot_api-0.1.3-py2-none-any.whl (5.4 kB) File type Wheel Python version py2 Upload date Hashes View hashes
Filename, size benchbot_api-0.1.3.tar.gz (3.7 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page