Getting Started

First, see Installation to get the holodeck package and DefaultWorlds installed.

A minimal Holodeck usage example is below:

import holodeck
import numpy as np

env = holodeck.make("UrbanCity-MaxDistance")

# The UAV takes 3 torques and a thrust as a command.
command = np.array([0, 0, 0, 100])

for _ in range(180):
   state, reward, terminal, info = env.step(command)

Notice that:

  1. You pass the name of a scenario into holodeck.make

    See Packages for all of the different worlds and scenarios that are available.

  2. The interface of Holodeck is designed to be familiar to OpenAI Gym

  1. You must call .reset() before calling .step() or .tick()

You can access data from a specific sensor with the state dictionary:

location_data = state["LocationSensor"]

That’s it! Holodeck is meant to be fairly simple to use.

Check out the different worlds that are available, read the API documentation, or get started on making your own custom scenarios.

Code Examples

Below are some snippets that show how to use different aspects of Holodeck.

There is also an in the root of the holodeck repo with more example code.