Skip to main content

MASA-Safe-RL

title card


Welcome to MASA-Safe-RL, the Multi and Single Agent (MASA) Safe Reinforcement Learning library. The primary goal of this library is to develop a set of common constraints and environments for safe reinforcement learning research, built on top of the popular gymnasium interface. We span, CMPDs, probabilistic constraints, Reach-Avoid and LTL-Safety (DFA) properties.

The library is in very early stage development and we greatly appreciate and encourage feedback from the community about what they would like to see implemented. Currently we provide a set of basic tabular algroithms for safe RL, but we provide a modular and resuable framework for developing more complex algorithms and constraints.

If you use MASA-Safe-RL in your research please cite it in your publications.

@misc{Goodall2025MASASafeRL,
  title        = {{MASA-Safe-RL}: Multi and Single Agent Safe Reinforcement Learning},
  author       = {Goodall, Alexander W. and Adalat, Omar and Hamel De-le Court, Edwin and Belardinelli, Francesco},
  year         = {2025},
  howpublished = {\url{https://github.com/sacktock/MASA-Safe-RL/}},
  note         = {GitHub repository}
}

Quick Start

Installation

Prequisites

Python 3.10+ is required (3.10 recommended), later versions may be supported.

Installation with conda

  • Install conda, e.g., via anaconda.
  • Clone the repo:
git clone https://github.com/sacktock/MASA-Safe-RL.git
cd MASA-Safe-RL
  • Create a conda virtual environment:
conda env create --name masa --file conda-environment.yaml
conda activate masa
  • Install dependencies:
pip install -e .

Installation with uv

uv sync installs only base dependency package from the repository root.

Easiest way to install all dependencies: All dependency groups (docs and GPU support): uv sync --all-groups --no-group cuda13. Alternatively, uv sync --all-groups --no-group cuda12 if your system only supports CUDA 12.

More minimal ways of installing dependency groups:

  • For building docs, use uv sync --group docs from the repository root.
  • Adding GPU support for Jax: uv sync --group cuda13 (or cuda12 if CUDA 13 is not supported by your device)

Installation with PyPI

MASA-Safe-RL is now available on PyPI: MASA-Safe-RL.

pip install -U MASA-Safe-RL

Enabling GPU Acceleration with JAX (Optional)

MASA-Safe-RL relies on JAX for GPU acceleration. If you are only interested in the gymnasium wrappers and constraints API then you do not need to complete the following steps.

Mac and Windows

MAC and Windows: we recommend JAX with CPU. No further action is required if you correctly followed the earlier steps.

pip

  • Linux x86_64/aarch64 and Windows WSL2 x86_64: W+we strongly recommend using Ubuntu 22.04 or similar, jax and jaxlib should already be installed via the requirements.txt. You need to reinstall JAX based on your cuda driver compatibility. Do not use the -U option here as it may break earlier dependencies!
pip install "jax[cuda13]"
pip install "jax[cuda12]"

uv

Alternatively with uv,

uv sync --group cuda12
uv sync --group cuda13

How to run MASA

  • You can run masa with the prebuilt CLI:
masa run --env-id bridge_crossing --algo ppo --seed 0
  • You can run examples from the \examples folder via:
masa example prob_shield_example

Editing documentation

Documentation uses the root pyproject.toml and uv.lock, so you can build and serve it directly from the repository root.

uv sync --group docs
uv run --locked --group docs sphinx-build -W -b html docs docs/_build/html

The built site will be available at docs/_build/html/index.html.

For live reload while editing, run:

uv run --locked --group docs sphinx-autobuild docs docs/_build/html

Getting in Touch

MASA-Safe-RL is primarliy managed by Alex Goodall and Omar Adalat. For correspondence in the early stages of the library we prefer you contact us directly via email (a.goodall22@imperial.ac.uk), rather than raising issues on GitHub directly.

License

MASA-Safe-RL is released under Apache License 2.0.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

masa_safe_rl-0.3.6.tar.gz (270.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

masa_safe_rl-0.3.6-py3-none-any.whl (412.1 kB view details)

Uploaded Python 3

File details

Details for the file masa_safe_rl-0.3.6.tar.gz.

File metadata

  • Download URL: masa_safe_rl-0.3.6.tar.gz
  • Upload date:
  • Size: 270.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.12.12 {"installer":{"name":"uv","version":"0.12.12","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for masa_safe_rl-0.3.6.tar.gz
Algorithm Hash digest
SHA256 a9b37d07abaa57799ca89e586aac744e3e4d7093b909cf6383b39af372a68c7f
MD5 33430de0eb013b41b9ca0a7adcbf1161
BLAKE2b-256 6e19a5f5f24a5805db79b111435d58b6e710515a7b27d2c41dc0408b53794e66

See more details on using hashes here.

File details

Details for the file masa_safe_rl-0.3.6-py3-none-any.whl.

File metadata

  • Download URL: masa_safe_rl-0.3.6-py3-none-any.whl
  • Upload date:
  • Size: 412.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.12.12 {"installer":{"name":"uv","version":"0.12.12","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for masa_safe_rl-0.3.6-py3-none-any.whl
Algorithm Hash digest
SHA256 9a730c73bb86c480104cddbc3cc39329bdc5db2867602b20deb865543492a0f3
MD5 d37e5ddaf4968a756201e9b9362a8df7
BLAKE2b-256 b0bc44d2be84f3c7a0eda9b7ba19723e8f80b396eb435006f1570c1e9da6ac6e

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

0.3.6 This release

2 files

0.3.5

2 files

0.3.4

2 files

0.3.3

2 files

0.3.2

2 files

0.3.1

2 files

0.3.0

2 files

0.2.8

2 files

0.2.7

2 files

0.2.6

2 files

0.2.5

2 files

0.2.4

2 files

0.2.3

2 files

0.2.2

2 files

0.1.3

2 files

0.1.2

2 files

0.1.1

2 files

0.1.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page