From 1cc2572afccf0402a90593c26aa17f7ae7850f35 Mon Sep 17 00:00:00 2001 From: Melvin Laux Date: Tue, 3 Sep 2024 12:42:09 +0200 Subject: [PATCH 1/6] Drop support of EOL python 3.8 --- .github/workflows/test.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/test.yaml b/.github/workflows/test.yaml index 0f93b2c..e6f9b30 100644 --- a/.github/workflows/test.yaml +++ b/.github/workflows/test.yaml @@ -16,7 +16,7 @@ jobs: strategy: fail-fast: false matrix: - python-version: ["3.8", "3.9", "3.10", "3.11"] + python-version: ["3.9", "3.10", "3.11", "3.12"] steps: - uses: actions/checkout@v3 From 61db082b3a62faa1ff748616481d9020f94ca691 Mon Sep 17 00:00:00 2001 From: Melvin Laux Date: Tue, 3 Sep 2024 12:48:25 +0200 Subject: [PATCH 2/6] Run tests on develpment branch --- .github/workflows/test.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/test.yaml b/.github/workflows/test.yaml index e6f9b30..b304c3b 100644 --- a/.github/workflows/test.yaml +++ b/.github/workflows/test.yaml @@ -5,9 +5,9 @@ name: Tests on: push: - branches: [ main ] + branches: [main, development] pull_request: - branches: [ main ] + branches: [main, development] jobs: build: From 9016414b299883d214dbc2ae23fe481acca98079 Mon Sep 17 00:00:00 2001 From: Melvin Laux Date: Tue, 3 Sep 2024 13:03:26 +0200 Subject: [PATCH 3/6] Add link to mujoco and fix typos --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 888be3f..6b32126 100644 --- a/README.md +++ b/README.md @@ -3,8 +3,8 @@ [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit) # DeformableGym -This repository contains a collection of [gymnasium](https://github.com/Farama-Foundation/Gymnasium) environments built with [PyBullet](https://pybullet.org/). In these environments, the agent -needs to learn to grasp deformable object such as shoe insoles or pillows from sparse reward signals. +This repository contains a collection of [gymnasium](https://github.com/Farama-Foundation/Gymnasium) environments built with [PyBullet](https://pybullet.org/) and [MuJoCo](https://github.com/google-deepmind/mujoco). +In these environments, the agent needs to learn to grasp deformable 3D objects such as shoe insoles or pillows from sparse reward signals.

@@ -100,7 +100,7 @@ pip install numpydoc sphinx sphinx-gallery sphinx-bootstrap-theme If you wish to report bugs, please use the [issue tracker](https://github.com/dfki-ric/deformable_gym/issues). If you would like to contribute to DeformableGym, just open an issue or a [pull request](https://github.com/dfki-ric/deformable_gym/pulls). The target branch for -merge requests is the development branch. The development branch will be merged to master for new releases. If you have +merge requests is the development branch. The development branch will be merged to main for new releases. If you have questions about the software, you should ask them in the discussion section. The recommended workflow to add a new feature, add documentation, or fix a bug is the following: From ad9ae2e949fe0e1a8ee409d88a6a17328b21c86a Mon Sep 17 00:00:00 2001 From: Melvin Laux Date: Tue, 3 Sep 2024 13:27:58 +0200 Subject: [PATCH 4/6] Add table overview of available envrionments --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index 6b32126..e81bd60 100644 --- a/README.md +++ b/README.md @@ -23,6 +23,22 @@ After cloning the repository, it is recommended to install the library in editab pip install -e . ``` +## Available environments + +| Environment Name | PyBullet | MuJoCo | +|---------------------------|:-------------------:|:------------------:| +| FloatingMiaGraspInsole | :heavy_check_mark: | :heavy_check_mark: | +| FloatingShadowGraspInsole | :heavy_check_mark: | :heavy_check_mark: | +| FloatingMiaGraspPillow | :heavy_check_mark: | :x: | +| FloatingShadowGraspInsole | :heavy_check_mark: | :x: | +| URMiaGraspInsole | :heavy_check_mark: | :x: | +| URShadowGraspInsole | :heavy_check_mark: | :x: | +| URMiaGraspPillow | :heavy_check_mark: | :x: | +| URShadowGraspPillow | :heavy_check_mark: | :x: | + + + + ### Known Issues If you use conda, you may experience the error below: From b001cb58e534887ad2d983e441a52faf9b8372a5 Mon Sep 17 00:00:00 2001 From: Melvin Laux Date: Tue, 3 Sep 2024 13:44:26 +0200 Subject: [PATCH 5/6] Add link to semver --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index e81bd60..1564b10 100644 --- a/README.md +++ b/README.md @@ -149,7 +149,7 @@ url = {https://deformable-workshop.github.io/icra2023/}, ### Semantic Versioning -Semantic versioning must be used, that is, the major version number will be +[Semantic versioning](https://semver.org/) must be used, that is, the major version number will be incremented when the API changes in a backwards incompatible way, the minor version will be incremented when new functionality is added in a backwards compatible manner, and the patch version is incremented for bugfixes, From 3c7475a66c5018dc934b0e4812fa974809043a1b Mon Sep 17 00:00:00 2001 From: Melvin Laux Date: Tue, 3 Sep 2024 13:45:40 +0200 Subject: [PATCH 6/6] Bump version --- setup.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/setup.py b/setup.py index 120571e..85eab90 100644 --- a/setup.py +++ b/setup.py @@ -6,7 +6,7 @@ setup( name="deformable_gym", - version="0.4.0", + version="0.4.1", maintainer="Melvin Laux", maintainer_email="melvin.laux@uni-bremen.de", description="Gym environments for grasping deformable objects",