Tutorials: Installation

qiBullet is compatible with Python (2.7, 3.5, 3.6, 3.7, 3.8). The following modules are required (please note that they will be automatically installed if you use pip):

• numpy
• pybullet

Additional resources (robot meshes and URDFs) are required in order to be able to spawn a Pepper, NAO or Romeo robot in the simulation. These extra resources will be installed in your home folder:

• /home/username/.qibullet on Linux and macOS
• C:\Users\username\.qibullet on Windows

The installation of the additional resources will automatically be triggered if you try to spawn a Pepper, NAO or Romeo for the first time. If qiBullet finds the additional resources in your local folder, the installation won't be triggered. The robot meshes are under a specific license, you will need to agree to that license in order to install them.

Using pip

The qiBullet module can be installed via pip, for python 2.7 and python 3:

pip install --user qibullet

From source

Some resources (the meshes and their installers) are handled with git-lfs (large file storage). Before cloning the repo, make sure that you have git-lfs installed. Clone the qiBullet repository, and install it on your computer:

python setup.py install --user

(develop can also be specified as a parameter instead of install, allowing you to conveniently edit qiBullet's code, and have the changes take effect immediately without re-installing the project)

You will encounter a bad magic number error when installing the extra resources if git-lfs isn't correctly installed. To solve that error, install git-lfs, go the the repository folder, and type in git lfs pull. This command will download the lfs resources, you can then resume installing qiBullet.