Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update readme #44

Merged
merged 2 commits into from
Jun 20, 2024
Merged

Update readme #44

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4d9e094
Update readme
jagdeepsb Jun 20, 2024
8d83bc0
Add badges
jagdeepsb Jun 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 12 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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).

[//]: # (<img src="images/teaser.gif" alt="teaser" width="800"/>)
![teaser](images/teaser.gif)
> [!NOTE]
> Evogym has been recently updated! TLDR: requirements have been modernized, and the library is now pip-installable.

[//]: # (<img src="https://github.com/EvolutionGym/evogym/blob/main/images/teaser.gif" alt="teaser" width="800"/>)
![teaser](https://github.com/EvolutionGym/evogym/blob/main/images/teaser.gif)

# Installation

Expand All @@ -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

Expand Down
Loading