Stable#

The stable channel is the easiest way to setup your system. As described in the support policy, this channel allows installing Gz from binary packages.

We publish updated stable packages after any tagged release of the master branch.

Virtual Environment (optional)#

This step is optional but highly recommended. Visit the virtual environments documentation for more details.

sudo apt install virtualenv
virtualenv -p python3.8 $HOME/venv
source $HOME/venv/bin/activate

Note that the activation is temporary and it is valid only in the same terminal. Make sure to execute the next steps in a terminal where the virtual environment is active.

PyPI Package#

We provide two different packages for ScenarIO and gym-gz.

If you are interested in the ScenarIO package, install the scenario package from PyPI:

pip install scenario

Instead, if you are interested in gym-gz, install the gym-gz package from PyPI:

pip install gym-gz

It will download and install also scenario since it depends on it.