Metadata-Version: 2.4
Name: RoutingGraphEnv
Version: 0.0.1
Summary: A Gymnasium environment for route optimization on OpenStreetMap road networks
Project-URL: Homepage, https://github.com/TruongHaiDang/routing-graph
Project-URL: Repository, https://github.com/TruongHaiDang/routing-graph.git
Project-URL: Issues, https://github.com/TruongHaiDang/routing-graph/issues
Author: Trương Hải Đăng
License-Expression: MIT
License-File: LICENSE
Keywords: gymnasium,openstreetmap,reinforcement-learning,route-optimization,routing
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Requires-Python: >=3.11
Requires-Dist: gymnasium
Requires-Dist: osmnx
Requires-Dist: pygame>=2.1.3
Description-Content-Type: text/markdown

# Gymnasium Examples
Some simple examples of Gymnasium environments and wrappers.
For some explanations of these examples, see the [Gymnasium documentation](https://gymnasium.farama.org).

### 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 RoutingGraphEnv
pip install -e .
```

## Upload to pypi.org

Chạy tại thư mục project:

```shell
python3 -m build
```

Lệnh sẽ tạo thư mục `dist/` chứa file `.whl` và `.tar.gz`.

Nếu chưa có module `build`:

```shell
python3 -m pip install build
```

Sau đó:

```shell
python3 -m twine upload dist/*
```