This projects helps scaffolding your own Gymnasium environment. For more explanation on how to create our own environment, see the Gymnasium documentation.
- Install
pipx
following the pipx documentation. - Then install Copier:
pipx install copier
Install Copier with Pip or Conda:
pip install copier
or
conda install -c conda-forge copier
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
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.