Installation on Ubuntu

This installation procedure has been tested with Ubuntu 22.04, with python 3.10.12

Pip installation

sudo apt update
sudo apt install python3-pip

The safe way to work with Python is to create a virtual environment around the project.

For that, you have to install some tools:

sudo apt install virtualenvwrapper

To install this git repository, go to the directory you want to work in (for example: ~/code/).
Git-clone the code of SwarmRL:

git clone https://github.com/minhpham160603/SwarmRL.git

This command will create the directory SwarmRL with all the code inside it.

Create your virtual environment. This command will create a directory env where all dependencies will be installed:

cd SwarmRL
python3 -m venv env

To use this newly create virtual environment, as each time you need it, use the command:

source env/bin/activate

To deactivate this virtual environment, simply type: deactivate

With this virtual environment activated, we can install all the dependency with the command:

python -m pip install --upgrade pip
python -m pip install -r requirements.txt

python -m pip install -e ./

python src/demos/demo_single_env.py