# gymnasium-env-template

**Repository Path**: prg/gymnasium-env-template

## Basic Information

- **Project Name**: gymnasium-env-template
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2025-01-27
- **Last Updated**: 2025-03-04

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 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](https://gymnasium.farama.org/tutorials/gymnasium_basics/environment_creation/).

## Setup

### Recommended solution
1. Install `pipx` following the [pipx documentation](https://pypa.github.io/pipx/installation/).
2. Then install Copier:
```{sh}
pipx install copier
```

### Alternative solutions

Install Copier with Pip or Conda:
```{sh}
pip install copier
```
or
```{sh}
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](https://github.com/Farama-Foundation/Gymnasium/tree/main/docs).