Skip to content

Commit

Permalink
Update tutorials readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jagdeepsb committed Jun 13, 2024
1 parent 2b66b16 commit 8a21708
Showing 1 changed file with 23 additions and 1 deletion.
24 changes: 23 additions & 1 deletion tutorials/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,25 @@
# Tutorials

This folder contains completed code for all tutorials on our [website](https://evolutiongym.github.io/tutorials).
This folder contains completed code for all tutorials on our [website](https://evolutiongym.github.io/tutorials).

## Custom Environment

To see an example of custom environment creation, see `envs/simple_env.py`. This environment is registered in `envs/__init__.py`, and can be visualized by running `python .\visualize_simple_env.py` from this directory.

## Evogym Simulator API

See `basic_api.py` for a simple example of how to create, step, and render an Evogym simulator with objects of your choice. Evogym can be used to simulate any number of objects and robots (although simulation speed may slow with many objects).

To see understand the different rendering options available in Evogym, see `rendering_options.py`.
You can run:

```bash
python .\rendering_options.py --render-option to-debug-screen
```

| Option | Description |
|--------------------|------------------------------------------------------------------------|
| to-debug-screen | Render to Evogym's default viewer |
| to-numpy-array | Render to a numpy array (visualized with open cv) |
| special-options | Render with special flags (for pretty visualization) |
| very-fast | Render without fps limit |

0 comments on commit 8a21708

Please sign in to comment.