Skip to content

Installation

Environments 🌍

Before installing, ensure you have the correct JAX installation for your hardware accelerator. We have tested up to JAX version 0.4.36. The JaxMARL environments can be installed directly from PyPi:

pip install jaxmarl

Algorithms 🦉

If you would like to also run the algorithms, install the source code as follows:

  1. Clone the repository: 
    git clone https://github.com/FLAIROx/JaxMARL.git && cd JaxMARL
  2. Install requirements: 
    pip install -e .[algs] && export PYTHONPATH=./JaxMARL:$PYTHONPATH
  3. For the fastest start, we reccoment using our Dockerfile, the usage of which is outlined below.

Development 🔨

If you would like to run our test suite, install the additonal dependencies as follows after cloning the repository: 

pip install -e .[dev]

Dockerfile 🐋

To help get experiments up and running we include a Dockerfile and its corresponding Makefile. With Docker and the Nvidia Container Toolkit installed, the container can be built with: 

make build
The built container can then be run: 
make run