Soft-robotics control environment package for OpenAI Gym
Project description
The environment is designed to leverage wide-range of reinforcement learning methods into soft-robotics control. Our inspiration is from slender-body living creatures, such as octopus or snake. The code is based on PyElastica, an open-source physics simulation for highly-deformable slender structure. We intend this package to be easy-to-install and fully compatible to OpenAI Gym and other available RL algorithms.
The package is under development, in Alpha phase. Detail roadmap for Q2-2022 will be available.
Installation
pip install gym-softrobot
To test the installation, we provide few debugging scripts. The environment can be tested using the following command.
python -m gym_softrobot.debug.make # Make environment and run 10 steps
python -m gym_softrobot.debug.registry # Print gym-softrobot environment
Requirements:
- Python 3.8+
- OpenAI Gym 0.21.0
- PyElastica 0.2+
- Matplotlib (optional for display rendering and plotting)
- POVray (optional for 3D rendering)
Rendering
We support two different backends for the rendering: POVray and Matplotlib. The default is set to use POVray, but the configuration can be switched by adding following lines.
from gym_softrobot.config import RendererType
gym_softrobot.RENDERER_CONFIG = RendererType.MATPLOTLIB # Default: POVRAY
POVray
To make a good-looking 3D videos and figures, we use POVray python wrapper Vapory.
POVray is not a requirement to run the environment, but it is necessary to use env.render()
function as typical gym environment.
If you would like to test POVray
with gym-softrobot
, use
python -m gym_softrobot.debug.render # Render 10 frames using vapory
Matplotlib
We provide secondary rendering tool using Matplotlib for a quick debugging and sanity checking.
Reinforcement Learning Example
We tested the environment using Stable Baselines3 for centralized control. More advanced algorithms are still under development.
If you have your own algorithm that you would like to test with our environment, you are welcome to reach out to us.
Citation
Please use this bibtex to cite in your publications:
@misc{gym_softrobot,
author = {Chia-Hsien Shih, Seung Hyun Kim, Mattia Gazzola},
title = {Soft Robotics Environment for OpenAI Gym},
year = {2022},
publisher = {GitHub},
journal = {GitHub repository},
howpublished = {\url{https://github.com/skim0119/gym-softrobot}},
}
Environment Documentation
The description of each environment is available in documentation.
Contribution
We are currently developing the package internally. We plan to deploy the package to open-development in Q2-2022.
Author
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
Built Distribution
File details
Details for the file gym-softrobot-0.1.4.tar.gz
.
File metadata
- Download URL: gym-softrobot-0.1.4.tar.gz
- Upload date:
- Size: 99.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.7.1 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.0
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9683f8e67a43a47ae7ffa8047f1c649bd8426a1258af5b1d2e0b7870fa55ea26 |
|
MD5 | 3913646a03a12a2b594203724775cee6 |
|
BLAKE2b-256 | fd9fc8064521ebd25ae1def73540be813c8d7f5f6e1b25aebc3647b3c868f422 |
File details
Details for the file gym_softrobot-0.1.4-py2.py3-none-any.whl
.
File metadata
- Download URL: gym_softrobot-0.1.4-py2.py3-none-any.whl
- Upload date:
- Size: 159.2 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.7.1 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.0
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 635caa9adb2fe5d6253f71a898d0d69399e1ae6b8529fe0e306ceaeb67bdf5c9 |
|
MD5 | 8c18c29550d71fa9691833267bd74c2e |
|
BLAKE2b-256 | 6958397e371813537539cf911f6a9f4ca6b52c4001083acdef1b236470c38af4 |