MASA-Safe-RL 0.1.0__tar.gz

masa_safe_rl-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

masa_safe_rl-0.1.0/MASA_Safe_RL.egg-info/PKG-INFO

@@ -0,0 +1,151 @@
+Metadata-Version: 2.4
+Name: MASA-Safe-RL
+Version: 0.1.0
+Summary: A safe reinforcement library for providing a common interface for different constraints and environments
+Project-URL: Homepage, https://github.com/sacktock/MASA-Safe-RL
+Project-URL: Repository, https://github.com/sacktock/MASA-Safe-RL
+Project-URL: Documentation, https://sacktock.github.io/MASA-Safe-RL/
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: gymnasium>=1.3.0
+Requires-Dist: pettingzoo>=1.26.1
+Requires-Dist: tensorflow>=2.20.0
+Requires-Dist: tensorflow-probability==0.25.0
+Requires-Dist: tensorstore>=0.1.65
+Requires-Dist: tf-keras>=2.17.0
+Requires-Dist: numpy>=1.26.4
+Requires-Dist: tensorboard>=2.17.1
+Requires-Dist: tqdm>=4.66.5
+Requires-Dist: jax>=0.4.30
+Requires-Dist: optax>=0.1.9
+Requires-Dist: flax>=0.9.0
+Requires-Dist: ml-dtypes>=0.4.1
+Requires-Dist: ruamel.yaml<0.20.0
+Requires-Dist: ipykernel>=7.2.0
+Requires-Dist: moviepy<3.0.0,>=2.2.1
+Requires-Dist: pillow<12.0.0,>=11.3.0
+Requires-Dist: pygame>=2.6.1
+Requires-Dist: ipywidgets>=8.1.5
+Requires-Dist: typer>=0.25.1
+Dynamic: license-file
+
+# MASA-Safe-RL
+
+![title card](images/logo_large.png)
+
+--------------------------------------------------------------------------------
+
+
+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](https://gymnasium.farama.org/) 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.
+
+```bibtex
+@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, although later Python versions may not be supported.
+
+#### Installation with conda 
+- Install conda, e.g., via [anaconda](https://anaconda.org/channels/anaconda/packages/conda/overview).
+- Clone the repo:
+```bash
+git clone https://github.com/sacktock/MASA-Safe-RL.git
+cd MASA-Safe-RL
+```
+- Create a conda virtual environment:
+```bash
+conda env create --name masa --file conda-environment.yaml
+conda activate masa
+```
+- Install dependencies:
+```bash
+pip install -e .
+```
+
+#### Installation with uv
+`uv sync` installs the base package from the repository root.
+
+* For building docs, use `uv sync --group docs` from the repository root.
+* Adding GPU support for Jax: `uv sync --group cuda12` (or `cuda13` if supported by your device)
+* All groups (docs and GPU support): `uv sync --all-groups`.
+
+#### Installation with PyPI
+
+Coming soon!
+
+### Enabling GPU Acceleration with JAX (Optional)
+
+MASA-Safe-RL relies on [JAX](https://docs.jax.dev/) 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](https://apps.microsoft.com/detail/9pn20msr04dw?hl=en-GB&gl=BE) or similar, jax and jaxlib should already be installed via the `requirements.txt`. You need to reinstall [JAX](https://docs.jax.dev/) based on your cuda driver compatibility. Do not use the ```-U``` option here as it may break earlier dependencies!
+```bash
+pip install "jax[cuda13]"
+```
+```bash
+pip install "jax[cuda12]"
+```
+
+#### uv
+Alternatively with `uv`,
+```bash
+uv sync --group cuda12
+```
+```bash
+uv sync --group cuda13
+```
+
+## How to run MASA
+- You can run masa with the prebuilt CLI:
+```bash
+masa run --env-id bridge_crossing --algo ppo --seed 0
+```
+- You can run examples from the ```\examples``` folder via:
+```bash
+masa examples 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.
+
+```bash
+uv sync --group docs
+uv run --locked --group docs sphinx-build -b html docs docs/_build/html
+```
+
+The built site will be available at `docs/_build/html/index.html`.
+
+For live reload while editing, run:
+
+```bash
+uv run --locked --group docs sphinx-autobuild docs docs/_build/html
+```
+
+
+## Getting in Touch
+
+MASA-Safe-RL is primarliy managed by [Alex Goodall](https://github.com/sacktock) and [Omar Adalat](https://github.com/nightly). 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.

masa_safe_rl-0.1.0/MASA_Safe_RL.egg-info/SOURCES.txt

@@ -0,0 +1,128 @@
+LICENSE
+README.md
+pyproject.toml
+MASA_Safe_RL.egg-info/PKG-INFO
+MASA_Safe_RL.egg-info/SOURCES.txt
+MASA_Safe_RL.egg-info/dependency_links.txt
+MASA_Safe_RL.egg-info/entry_points.txt
+MASA_Safe_RL.egg-info/requires.txt
+MASA_Safe_RL.egg-info/top_level.txt
+masa/__init__.py
+masa/run.py
+masa/algorithms/__init__.py
+masa/algorithms/a2c/__init__.py
+masa/algorithms/a2c/a2c.py
+masa/algorithms/ppo/__init__.py
+masa/algorithms/ppo/ppo.py
+masa/algorithms/tabular/__init__.py
+masa/algorithms/tabular/base.py
+masa/algorithms/tabular/lcrl.py
+masa/algorithms/tabular/q_learning.py
+masa/algorithms/tabular/q_learning_lambda.py
+masa/algorithms/tabular/recovery_rl.py
+masa/algorithms/tabular/recreg.py
+masa/algorithms/tabular/sem.py
+masa/cli/__init__.py
+masa/cli/cli_app.py
+masa/common/__init__.py
+masa/common/base_class.py
+masa/common/buffers.py
+masa/common/configs.py
+masa/common/dummy.py
+masa/common/label_fn.py
+masa/common/labelled_env.py
+masa/common/labelled_pz_env.py
+masa/common/layers.py
+masa/common/ltl.py
+masa/common/metrics.py
+masa/common/on_policy_algorithm.py
+masa/common/pctl.py
+masa/common/pettingzoo_record_video.py
+masa/common/policies.py
+masa/common/registry.py
+masa/common/running_mean_std.py
+masa/common/schedule.py
+masa/common/utils.py
+masa/common/wrappers.py
+masa/common/constraints/__init__.py
+masa/common/constraints/base.py
+masa/common/constraints/cmdp.py
+masa/common/constraints/ltl_safety.py
+masa/common/constraints/pctl.py
+masa/common/constraints/prob.py
+masa/common/constraints/reach_avoid.py
+masa/common/constraints/multi_agent/__init__.py
+masa/common/constraints/multi_agent/cmg.py
+masa/configs/__init__.py
+masa/configs/algorithms/__init__.py
+masa/configs/envs/__init__.py
+masa/envs/__init__.py
+masa/envs/continuous/__init__.py
+masa/envs/continuous/base.py
+masa/envs/continuous/cartpole.py
+masa/envs/discrete/__init__.py
+masa/envs/discrete/base.py
+masa/envs/discrete/cartpole.py
+masa/envs/discrete/conveyor_belt.py
+masa/envs/discrete/island_navigation.py
+masa/envs/discrete/mini_pacman_with_coins.py
+masa/envs/discrete/pacman_with_coins.py
+masa/envs/discrete/sokoban.py
+masa/envs/discrete/renderers/__init__.py
+masa/envs/discrete/renderers/cartpole.py
+masa/envs/discrete/renderers/pacman.py
+masa/envs/multiagent/matrix/_label_utils.py
+masa/envs/multiagent/matrix/bertrand.py
+masa/envs/multiagent/matrix/chicken.py
+masa/envs/multiagent/matrix/congestion.py
+masa/envs/multiagent/matrix/dpgg.py
+masa/envs/multiagent/matrix/inspection.py
+masa/envs/tabular/__init__.py
+masa/envs/tabular/base.py
+masa/envs/tabular/bridge_crossing.py
+masa/envs/tabular/bridge_crossing_v2.py
+masa/envs/tabular/colour_bomb_grid_world.py
+masa/envs/tabular/colour_bomb_grid_world_v2.py
+masa/envs/tabular/colour_bomb_grid_world_v3.py
+masa/envs/tabular/colour_grid_world.py
+masa/envs/tabular/media_streaming.py
+masa/envs/tabular/mini_pacman.py
+masa/envs/tabular/pacman.py
+masa/envs/tabular/utils.py
+masa/envs/tabular/renderers/__init__.py
+masa/envs/tabular/renderers/bridge_crossing.py
+masa/envs/tabular/renderers/colour_bomb_grid_world.py
+masa/envs/tabular/renderers/colour_grid_world.py
+masa/envs/tabular/renderers/media_streaming.py
+masa/envs/tabular/renderers/pacman.py
+masa/examples/__init__.py
+masa/examples/norm_obs_example.py
+masa/examples/prob_shield_cont_example.py
+masa/examples/prob_shield_cont_ltl_example.py
+masa/examples/prob_shield_example.py
+masa/examples/prob_shield_ltl_example.py
+masa/examples/prob_shield_safety_abstraction_example.py
+masa/examples/prob_shield_vec_ltl_example.py
+masa/examples/reward_shaping_example.py
+masa/examples/colour_bomb_grid_world/__init__.py
+masa/examples/colour_bomb_grid_world/property_1.py
+masa/examples/colour_bomb_grid_world/property_2.py
+masa/examples/colour_bomb_grid_world/property_3.py
+masa/plugins/__init__.py
+masa/plugins/helpers.py
+masa/plugins/supported.py
+masa/prob_shield/__init__.py
+masa/prob_shield/eventual_discounted_vi.py
+masa/prob_shield/helpers.py
+masa/prob_shield/interval_bound_vi.py
+masa/prob_shield/parameterized_policy.py
+masa/prob_shield/parameterized_policy_v2.py
+masa/prob_shield/parameterized_ppo.py
+masa/prob_shield/parameterized_ppo_v2.py
+masa/prob_shield/prob_shield_wrapper_v1.py
+masa/prob_shield/prob_shield_wrapper_v2.py
+tests/test_cmg.py
+tests/test_reach_avoid.py
+tests/test_record_video.py
+tests/test_sample.py
+tests/test_tutorial_notebooks.py

masa_safe_rl-0.1.0/MASA_Safe_RL.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

masa_safe_rl-0.1.0/MASA_Safe_RL.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+masa = masa.cli.cli_app:app

masa_safe_rl-0.1.0/MASA_Safe_RL.egg-info/requires.txt

@@ -0,0 +1,20 @@
+gymnasium>=1.3.0
+pettingzoo>=1.26.1
+tensorflow>=2.20.0
+tensorflow-probability==0.25.0
+tensorstore>=0.1.65
+tf-keras>=2.17.0
+numpy>=1.26.4
+tensorboard>=2.17.1
+tqdm>=4.66.5
+jax>=0.4.30
+optax>=0.1.9
+flax>=0.9.0
+ml-dtypes>=0.4.1
+ruamel.yaml<0.20.0
+ipykernel>=7.2.0
+moviepy<3.0.0,>=2.2.1
+pillow<12.0.0,>=11.3.0
+pygame>=2.6.1
+ipywidgets>=8.1.5
+typer>=0.25.1

masa_safe_rl-0.1.0/MASA_Safe_RL.egg-info/top_level.txt

@@ -0,0 +1 @@
+masa

masa_safe_rl-0.1.0/PKG-INFO

@@ -0,0 +1,151 @@
+Metadata-Version: 2.4
+Name: MASA-Safe-RL
+Version: 0.1.0
+Summary: A safe reinforcement library for providing a common interface for different constraints and environments
+Project-URL: Homepage, https://github.com/sacktock/MASA-Safe-RL
+Project-URL: Repository, https://github.com/sacktock/MASA-Safe-RL
+Project-URL: Documentation, https://sacktock.github.io/MASA-Safe-RL/
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: gymnasium>=1.3.0
+Requires-Dist: pettingzoo>=1.26.1
+Requires-Dist: tensorflow>=2.20.0
+Requires-Dist: tensorflow-probability==0.25.0
+Requires-Dist: tensorstore>=0.1.65
+Requires-Dist: tf-keras>=2.17.0
+Requires-Dist: numpy>=1.26.4
+Requires-Dist: tensorboard>=2.17.1
+Requires-Dist: tqdm>=4.66.5
+Requires-Dist: jax>=0.4.30
+Requires-Dist: optax>=0.1.9
+Requires-Dist: flax>=0.9.0
+Requires-Dist: ml-dtypes>=0.4.1
+Requires-Dist: ruamel.yaml<0.20.0
+Requires-Dist: ipykernel>=7.2.0
+Requires-Dist: moviepy<3.0.0,>=2.2.1
+Requires-Dist: pillow<12.0.0,>=11.3.0
+Requires-Dist: pygame>=2.6.1
+Requires-Dist: ipywidgets>=8.1.5
+Requires-Dist: typer>=0.25.1
+Dynamic: license-file
+
+# MASA-Safe-RL
+
+![title card](images/logo_large.png)
+
+--------------------------------------------------------------------------------
+
+
+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](https://gymnasium.farama.org/) 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.
+
+```bibtex
+@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, although later Python versions may not be supported.
+
+#### Installation with conda 
+- Install conda, e.g., via [anaconda](https://anaconda.org/channels/anaconda/packages/conda/overview).
+- Clone the repo:
+```bash
+git clone https://github.com/sacktock/MASA-Safe-RL.git
+cd MASA-Safe-RL
+```
+- Create a conda virtual environment:
+```bash
+conda env create --name masa --file conda-environment.yaml
+conda activate masa
+```
+- Install dependencies:
+```bash
+pip install -e .
+```
+
+#### Installation with uv
+`uv sync` installs the base package from the repository root.
+
+* For building docs, use `uv sync --group docs` from the repository root.
+* Adding GPU support for Jax: `uv sync --group cuda12` (or `cuda13` if supported by your device)
+* All groups (docs and GPU support): `uv sync --all-groups`.
+
+#### Installation with PyPI
+
+Coming soon!
+
+### Enabling GPU Acceleration with JAX (Optional)
+
+MASA-Safe-RL relies on [JAX](https://docs.jax.dev/) 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](https://apps.microsoft.com/detail/9pn20msr04dw?hl=en-GB&gl=BE) or similar, jax and jaxlib should already be installed via the `requirements.txt`. You need to reinstall [JAX](https://docs.jax.dev/) based on your cuda driver compatibility. Do not use the ```-U``` option here as it may break earlier dependencies!
+```bash
+pip install "jax[cuda13]"
+```
+```bash
+pip install "jax[cuda12]"
+```
+
+#### uv
+Alternatively with `uv`,
+```bash
+uv sync --group cuda12
+```
+```bash
+uv sync --group cuda13
+```
+
+## How to run MASA
+- You can run masa with the prebuilt CLI:
+```bash
+masa run --env-id bridge_crossing --algo ppo --seed 0
+```
+- You can run examples from the ```\examples``` folder via:
+```bash
+masa examples 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.
+
+```bash
+uv sync --group docs
+uv run --locked --group docs sphinx-build -b html docs docs/_build/html
+```
+
+The built site will be available at `docs/_build/html/index.html`.
+
+For live reload while editing, run:
+
+```bash
+uv run --locked --group docs sphinx-autobuild docs docs/_build/html
+```
+
+
+## Getting in Touch
+
+MASA-Safe-RL is primarliy managed by [Alex Goodall](https://github.com/sacktock) and [Omar Adalat](https://github.com/nightly). 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.