From 7f7980b696e6faae608403c11b3f2bd66bf1b9c3 Mon Sep 17 00:00:00 2001 From: Jagdeep Singh <24512034+jagdeepsb@users.noreply.github.com> Date: Thu, 20 Jun 2024 15:12:02 -0400 Subject: [PATCH] Update readme (#44) * Update readme * Add badges --- README.md | 23 ++++++++++++----------- 1 file changed, 12 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index dc114098..0e7e33ee 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,15 @@ # Evolution Gym -> [!CAUTION] -> This branch is under active development! -> -> Version 2 of `evogym` aims to make the following improvements: -> - Separation of requirements between core `evogym` library and `examples` -> - Modernize requirements (python, gym, numpy) -> - Pip-installable, with wheels for common builds -> - Tests +![example workflow](https://github.com/EvolutionGym/evogym/actions/workflows/wheels.yml/badge.svg) +![example workflow](https://github.com/EvolutionGym/evogym/actions/workflows/test.yml/badge.svg) Evolution Gym is a large-scale benchmark for co-optimizing the design and control of soft robots. It provides a lightweight soft-body simulator wrapped with a gym-like interface for developing learning algorithms. Evogym also includes a suite of 32 locomotion and manipulation tasks, detailed on our [website](https://evolutiongym.github.io/all-tasks). Task suite evaluations are described in our [NeurIPS 2021 paper](https://arxiv.org/pdf/2201.09863). -[//]: # (teaser) -![teaser](images/teaser.gif) +> [!NOTE] +> Evogym has been recently updated! TLDR: requirements have been modernized, and the library is now pip-installable. + +[//]: # (teaser) +![teaser](https://github.com/EvolutionGym/evogym/blob/main/images/teaser.gif) # Installation @@ -23,7 +20,11 @@ pip install --upgrade evogym ``` > [!CAUTION] -> This doesn't work yet -- coming soon! +> This doesn't work yet -- coming soon! For now, you can install from test pypi: +> ```shell +> pip install "numpy<2.0.0" gymnasium +> pip install -i https://test.pypi.org/simple/ evogym +> ``` ## From Source