Skip to main content

SafeGym

Implementation of satellite environments and other environments to explore SafeRL

SafeGym

SafeGym is a Gymnasium environment coupled with tools aimed at facilitating Safe Reinforcement Learning (SafeRL) research and development.

Features

  • Customizable Environment: Create a variety of satellite chasing scenarios with customizable starting states and noise.
  • Underactuated and Fully Actuated Dynamics: Simulate real-world control dynamics with options for both underactuated and fully actuated control systems.
  • Reward Shaping: Built-in reward shaping functionality to guide the learning process towards safe and effective solutions.
  • Truncation and Termination: Control the episode flow with truncation and termination conditions to manage the agent's learning experience.
  • Visualization Tools: Render the environment and visualize the agent's interactions and performance over time.
  • Testing Utilities: Validate the environment and control algorithms with a set of provided testing functions.

Getting Started

Clone the repository to your local machine:

git clone https://github.com/spbisc97/SafeGym.git
cd SafeGym

Ensure you have the necessary dependencies installed. The primary dependencies include:

  • gymnasium
  • numpy
  • matplotlib

Usage

Install

pip install -e .

Run a simple experiment

import safegym
import gymnasium as gym

env = gym.make('Satellite-SE',render_mode="human")
observation,info = env.reset()
DONE=False

while not DONE
    action = env.action_space.sample()
    observation, reward, term, trunc, info = env.step(action)
    DONE = term or trunc

env.close()

Metadata

Release files for safegym 0.14

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for safegym 0.14
File Size Uploaded
safegym-0.14.tar.gz 31.2 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for safegym 0.14
File Interpreter ABI Platform
safegym-0.14-py3-none-any.whl Python 3 none any Details

Total release size: 67.9 kB

Release files / safegym-0.14.tar.gz

Download URL safegym-0.14.tar.gz
Size 31.2 kB
Tags Source
SHA-256 checksum
How to use checksums
04b49cbde8da64244f642d7cdf83ce8cfb4942325e0792f37c4f96786dc61518
BLAKE2b-256 checksum
How to use checksums
b966b08bbbdaa3dc295654c6ac7eb6a9e25c0658679e9ac6c174d3fc0477df57
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.10.11

Release files / safegym-0.14-py3-none-any.whl

Download URL safegym-0.14-py3-none-any.whl
Size 36.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
5db39110f29010d1c11ed8dd50581438099ecd47410cd96afb8fb875503bb80e
BLAKE2b-256 checksum
How to use checksums
d0dd28f81b5b03d360b04f2808276e4b86886cc7f9772ae032a95c0f90f37f2f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.10.11

Release history Release notifications | RSS feed

This release

0.14 This release

2 release files

0.13

2 release files

0.12

2 release 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