Skip to content
A toolkit for robot learning research.
Python C Lua
Branch: master
Clone or download

README.md

PyRep Build Status Documentation Status

PyRep is a toolkit for robot learning research, built on top of the virtual robotics experimentation platform (V-REP).

Install

In addition to the PyRep API, you will aso need to download the latest version of V-REP from the downloads page.

Once you have downloaded V-REP, you can pull PyRep from git:

git clone https://github.com/stepjam/PyRep.git
cd PyRep

Add the following to your ~/.bashrc file: (NOTE: the 'EDIT ME' in the first line)

export VREP_ROOT=EDIT/ME/PATH/TO/V-REP/INSTALL/DIR
export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:$VREP_ROOT
export QT_QPA_PLATFORM_PLUGIN_PATH=$VREP_ROOT

Remember to source your bashrc after this: source ~/.bashrc.

Finally install the python library:

pip3 install -r requirements.txt
python3 setup.py install --user

You should be good to go! Try running one of the examples in the examples/ folder.

Although you can use V-REP on any platform, communication via PyRep is currently only supported on Linux.

Running Headless

If you plan to run on a headless machine, you will also need to run with a virtual framebuffer. E.g.

sudo apt-get install xvfb
xvfb-run python3 my_pyrep_app.py

Troubleshooting

Below are some problems you may encounter during installation. If none of these solve your problem, please raise an issue.

  • ModuleNotFoundError: No module named 'pyrep.backend._v_rep_cffi'
    • If you are getting this error, then please check that you are not running the interpreter from the project root. If you are, then your Python interpreter will try to import those files rather the installed files.
  • error: command 'x86_64-linux-gnu-gcc' failed
    • You may be missing packages needed for building python extensions. Try: sudo apt-get install python3-dev, and then re-run the installation.

Getting Started

  1. First take a look at Usage and the examples in the examples/ folder to see if PyRep might be able to accelerate your research.
  2. Take a look at the V-REP tutorials.

Usage

The best way to see how PyRep can help in your research is to look at the examples in the examples/ folder!

Launching the simulation

from pyrep import PyRep

pr = PyRep()
# Launch the application with a scene file in headless mode
pr.launch('scene.ttt', headless=True) 
pr.start()  # Start the simulation

# Do some stuff

pr.stop()  # Stop the simulation
pr.shutdown()  # Close the application

Modifying the Scene

from pyrep.objects.shape import Shape
from pyrep.const import PrimitiveShape

object = Shape.create(type=PrimitiveShape.CYLINDER, 
                      color=[r,g,b], size=[w, h, d],
                      position=[x, y, z])
object.set_color([r, g, b])
object.set_position([x, y, z])

Using Robots

Robots are designed to be modular; arms are treated separately to grippers.

Use the robot ttm files defined in robots/ttms. These have been altered slightly from the original ones shipped with V-REP to allow them to be used with motional planning out of the box. The 'tip' of the robot may not be where you want it, so feel free to play around with this.

from pyrep import PyRep
from pyrep.robots.arms.panda import Panda
from pyrep.robots.end_effectors.panda_gripper import PandaGripper

pr = PyRep()
# Launch the application with a scene file that contains a robot
pr.launch('scene_with_panda.ttt') 
pr.start()  # Start the simulation

arm = Panda()  # Get the panda from the scene
gripper = PandaGripper()  # Get the panda gripper from the scene

velocities = [.1, .2, .3, .4, .5, .6, .7]
arm.set_joint_target_velocities(velocities)
pr.step()  # Step physics simulation

done = False
# Open the gripper halfway at a velocity of 0.04.
while not done:
    done = gripper.actuate(0.5, velocity=0.04)
    pr.step()
    
pr.stop()  # Stop the simulation
pr.shutdown()  # Close the application

We recommend constructing your robot in a dictionary or a small structure, e.g.

class MyRobot(object):
  def __init__(self, arm, gripper):
    self.arm = arm
    self.gripper = gripper

arm = Panda()  # Get the panda from the scene
gripper = PandaGripper()  # Get the panda gripper from the scene

# Create robot structure
my_robot_1 = MyRobot(arm, gripper)
# OR
my_robot_2 = {
  'arm': arm,
  'gripper': gripper
}

Running Multiple PyRep Instances

Each PyRep instance needs its own process. This can be achieved using Pythons multiprocessing module. Here is a simple example:

from multiprocessing import Process

PROCESSES = 10

def run():
  pr = PyRep()
  pr.launch('my_scene.ttt', headless=True)
  pr.start()
  # Do stuff...
  pr.stop()
  pr.shutdown()

processes = [Process(target=run, args=()) for i in range(PROCESSES)]
[p.start() for p in processes]
[p.join() for p in processes]

Supported Robots

Here is a list of robots currently supported by PyRep:

Arms

  • Kinova Mico
  • Kinova Jaco
  • Rethink Baxter
  • Rethink Sawyer
  • Franka Emika Panda
  • Kuka LBR iiwa 7 R800
  • Kuka LBR iiwa 14 R820
  • Universal Robots UR3
  • Universal Robots UR5
  • Universal Robots UR10

Grippers

  • Kinova Mico Hand
  • Kinova Jaco Hand
  • Rethink Baxter Gripper
  • Franka Emika Panda Gripper

Mobile Robots

  • Kuka YouBot
  • Turtle Bot
  • Line Tracer

Feel free to send pull requests for new robots!

Adding Robots

If the robot you want is not currently supported, then why not add it in!

Here is a tutorial for adding robots.

Planned Future Updates

  • Support for MuJoCo
  • Sim-to-Real support (e.g. domain randomization)

Contributing

We want to make PyRep the best tool for rapid robot learning research. If you would like to get involved, then please get in contact!

Pull requests welcome for bug fixes!

Projects Using PyRep

If you use PyRep in your work, then get in contact and we can add you to the list!

Acknowledgements

  • Georges Nomicos (Imperial College London) for the addition of mobile platforms.

Citation

@article{james2019pyrep,
  title={PyRep: Bringing V-REP to Deep Robot Learning},
  author={James, Stephen and Freese, Marc and Davison, Andrew J.},
  journal={arXiv preprint arXiv:1906.11176},
  year={2019}
}
You can’t perform that action at this time.