Metadata-Version: 2.4
Name: crosswalk-env
Version: 0.1.2
Summary: A Gymnasium environment for risky decision-making
Author-email: Jinwoo Jeong <jwjeong96@gmail.com>
License: MIT
Project-URL: Homepage, https://crosswalk-task.github.io
Project-URL: Repository, https://github.com/crosswalk-task/CrosswalkEnv
Project-URL: Issues, https://github.com/crosswalk-task/CrosswalkEnv/issues
Requires-Python: <3.13,>=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pygame>=2.1
Requires-Dist: numpy<3,>=1.21
Requires-Dist: gymnasium<2,>=0.28
Dynamic: license-file

# CrosswalkEnv

[![PyPI version](https://img.shields.io/pypi/v/crosswalk-env.svg)](https://pypi.org/project/crosswalk-env/)

A [Gymnasium](https://gymnasium.farama.org/index.html) environment for risky decision-making.

## Requirements

* Python 3.9–3.12

## Installation

```bash
pip install crosswalk-env
```

## Documentation

For guides, API references, and examples, see the [Crosswalk Task documentation](https://crosswalk-task.github.io/).

* [Getting Started](https://crosswalk-task.github.io/crosswalkenv/getting_started.html)
* [Running Crosswalk Tasks](https://crosswalk-task.github.io/crosswalkenv/task.html)
* [CrosswalkEnv API](https://crosswalk-task.github.io/crosswalkenv/environment.html)
* [Training RL Agents](https://crosswalk-task.github.io/crosswalkenv/training_agents.html)
* [Observation Space](https://crosswalk-task.github.io/crosswalkenv/obs_space.html)

## Live Web Demo

For the web version, see [CrosswalkWebEnv](https://github.com/crosswalk-task/CrosswalkWebEnv).

Try the [Crosswalk Task Web Demo](https://crosswalk-task.github.io/demo).
