Metadata-Version: 2.4
Name: artgym_env
Version: 0.0.2
Summary: Gymnasium environments and wrappers published by ART team. It is a part of ART-Framework(TM) and ART-Gym(TM).
Author-email: Sean Yi <sangyobe@gmail.com>, Sean Yi <sean.yi@hyundai.com>
License-File: LICENSE
Keywords: art framework,gymnasium,leoquad,mujoco,reinforcement learning
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.7
Requires-Dist: gymnasium
Requires-Dist: pre-commit
Requires-Dist: pygame>=2.1.3
Description-Content-Type: text/markdown

# ART Gym Environment Package
ART environments and wrappers for Gymnasium.

### Environments
This repository hosts the examples that are shown [on the environment creation documentation](https://gymnasium.farama.org/tutorials/gymnasium_basics/environment_creation/).
- `GridWorldEnv`: Simplistic implementation of gridworld environment

### Wrappers
This repository hosts the examples that are shown [on wrapper documentation](https://gymnasium.farama.org/api/wrappers/).
- `ClipReward`: A `RewardWrapper` that clips immediate rewards to a valid range
- `DiscreteActions`: An `ActionWrapper` that restricts the action space to a finite subset
- `RelativePosition`: An `ObservationWrapper` that computes the relative position between an agent and a target
- `ReacherRewardWrapper`: Allow us to weight the reward terms for the reacher environment

### Contributing
If you would like to contribute, follow these steps:
- Fork this repository
- Clone your fork
- Set up pre-commit via `pre-commit install`

PRs may require accompanying PRs in [the documentation repo](https://github.com/Farama-Foundation/Gymnasium/tree/main/docs).


## Installation

To install your new environment, run the following commands:

```{shell}
cd artgym_env
pip install -e .
```
