README.md

Gymnasium environment template

This projects helps scaffolding your own Gymnasium environment. For more explanation on how to create our own environment, see the Gymnasium documentation.

Setup

Recommended solution

1. Install pipx following the pipx documentation.
2. Then install Copier:

pipx install copier

Alternative solutions

Install Copier with Pip or Conda:

pip install copier

or

conda install -c conda-forge copier

How to generate your environment

You can check that Copier has been correctly installed by running the following command, which should output a version number:

copier --version

Then you can just run the following command and replace the string path/to/directory by the path to the directory where you want to create your new project.

copier copy https://github.com/Farama-Foundation/gymnasium-env-template.git "path/to/directory"

Answer the questions, and when it's finished you should get a project structure 🌳 like the following:

.
├── gymnasium_env
│   ├── envs
│   │   ├── grid_world.py
│   │   └── __init__.py
│   ├── __init__.py
│   └── wrappers
│       ├── clip_reward.py
│       ├── discrete_actions.py
│       ├── __init__.py
│       ├── reacher_weighted_reward.py
│       └── relative_position.py
├── LICENSE
├── pyproject.toml
└── README.md

Contributing

If you would like to contribute, follow these steps:

• Fork this repository
• Clone your fork
• Set up pre-commit via pre-commit install
• Install the packages with pip install -e .
• Check you files manually with pre-commit run -a
• Run the tests with pytest -v

PRs may require accompanying PRs in the documentation repo.