Gymnasium Compatible Safe RL Environments
Project description
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()
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
safegym-0.14.tar.gz
(31.2 kB
view details)
Built Distribution
safegym-0.14-py3-none-any.whl
(36.7 kB
view details)
File details
Details for the file safegym-0.14.tar.gz
.
File metadata
- Download URL: safegym-0.14.tar.gz
- Upload date:
- Size: 31.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.10.11
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 04b49cbde8da64244f642d7cdf83ce8cfb4942325e0792f37c4f96786dc61518 |
|
MD5 | e8a6a1c7765c573fdba14dbd5988cc57 |
|
BLAKE2b-256 | b966b08bbbdaa3dc295654c6ac7eb6a9e25c0658679e9ac6c174d3fc0477df57 |
File details
Details for the file safegym-0.14-py3-none-any.whl
.
File metadata
- Download URL: safegym-0.14-py3-none-any.whl
- Upload date:
- Size: 36.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.10.11
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5db39110f29010d1c11ed8dd50581438099ecd47410cd96afb8fb875503bb80e |
|
MD5 | 0dbee0705d6021acd3c6d4ffec5c996e |
|
BLAKE2b-256 | d0dd28f81b5b03d360b04f2808276e4b86886cc7f9772ae032a95c0f90f37f2f |