rescue-gridworld 1.0.0__tar.gz

rescue_gridworld-1.0.0/PKG-INFO

@@ -0,0 +1,88 @@
+Metadata-Version: 2.4
+Name: rescue_gridworld
+Version: 1.0.0
+Summary: A procedural gridworld maze requiring completion of temporally extended tasks.
+Author-email: Andy Edmondson <Andy.Edmondson@ed.ac.uk>
+Project-URL: Homepage, https://github.com/Levinin/rescue_gridworld_env
+Project-URL: Bug Tracker, https://github.com/Levinin/rescue_gridworld_env/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: gymnasium
+Requires-Dist: numpy
+Requires-Dist: pygame
+
+# Rescue Gridworld
+
+This environment provides a Search and Rescue gridworld where the objective is to rescue all the people from the maze. To achieve this requires completion of a temporally extended sequence of tasks as follows.
+
+Exploration of the maze, opening locked doors to progress. Unlocking a door requires completion of the subtask sequence *collect key* -> *unlock cupboard* -> *collect keycard* -> *unlock door*.
+
+## Installation
+```bash
+pip install .
+```
+
+## Quick Start
+You can run a random agent to test the environment:
+```bash
+python run_random_agent.py --render --steps 1000 --rooms 5
+```
+
+## Manual Usage
+```python
+import gymnasium as gym
+import rescue_gridworld
+
+env = gym.make("RescueGridworld-v0", render_mode="human", num_rooms=5)
+obs, info = env.reset()
+# ... step the env ...
+```
+
+## Action Space
+
+There are 9 actions in the environment:
+- 0: Move up.
+- 1: Move down.
+- 2: Move left.
+- 3: Move right.
+- 4: Collect key.
+- 5: Unlock cupboard.
+- 6: Collect keycard.
+- 7: Unlock door.
+- 8: Talk to person.
+
+
+## Observation Space
+
+The observation provides 2 7x7 "windows". 
+- The first is a line-of-sight observation of the local environment.
+- The second is a line-of-sight filtered set of "chain id's". 
+
+The Python definitions are as follows to allow the grid to be viewed as an image.:
+```python
+    self.observation_space = spaces.Dict(
+        {
+            "grid": spaces.Box(low=0, high=255, shape=(1, 7, 7), dtype=np.uint8),
+            "chain_grid": spaces.Box(low=-2, high=500, shape=(1, 7, 7), dtype=np.int16),
+        }
+    )
+```
+
+
+
+
+
+## Rewards
+
+Reward of 5 is given for completion of subtasks:
+- Collect key.
+- Unlock cupboard.
+- Collect keycard.
+- Unlock door.
+- Talk to person.
+- Exit.
+
+An additional reward of 50 is given if all people have been saved before exiting.

rescue_gridworld-1.0.0/README.md

@@ -0,0 +1,72 @@
+# Rescue Gridworld
+
+This environment provides a Search and Rescue gridworld where the objective is to rescue all the people from the maze. To achieve this requires completion of a temporally extended sequence of tasks as follows.
+
+Exploration of the maze, opening locked doors to progress. Unlocking a door requires completion of the subtask sequence *collect key* -> *unlock cupboard* -> *collect keycard* -> *unlock door*.
+
+## Installation
+```bash
+pip install .
+```
+
+## Quick Start
+You can run a random agent to test the environment:
+```bash
+python run_random_agent.py --render --steps 1000 --rooms 5
+```
+
+## Manual Usage
+```python
+import gymnasium as gym
+import rescue_gridworld
+
+env = gym.make("RescueGridworld-v0", render_mode="human", num_rooms=5)
+obs, info = env.reset()
+# ... step the env ...
+```
+
+## Action Space
+
+There are 9 actions in the environment:
+- 0: Move up.
+- 1: Move down.
+- 2: Move left.
+- 3: Move right.
+- 4: Collect key.
+- 5: Unlock cupboard.
+- 6: Collect keycard.
+- 7: Unlock door.
+- 8: Talk to person.
+
+
+## Observation Space
+
+The observation provides 2 7x7 "windows". 
+- The first is a line-of-sight observation of the local environment.
+- The second is a line-of-sight filtered set of "chain id's". 
+
+The Python definitions are as follows to allow the grid to be viewed as an image.:
+```python
+    self.observation_space = spaces.Dict(
+        {
+            "grid": spaces.Box(low=0, high=255, shape=(1, 7, 7), dtype=np.uint8),
+            "chain_grid": spaces.Box(low=-2, high=500, shape=(1, 7, 7), dtype=np.int16),
+        }
+    )
+```
+
+
+
+
+
+## Rewards
+
+Reward of 5 is given for completion of subtasks:
+- Collect key.
+- Unlock cupboard.
+- Collect keycard.
+- Unlock door.
+- Talk to person.
+- Exit.
+
+An additional reward of 50 is given if all people have been saved before exiting.

rescue_gridworld-1.0.0/pyproject.toml

@@ -0,0 +1,31 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "rescue_gridworld"
+version = "1.0.0"
+authors = [
+  { name="Andy Edmondson", email="Andy.Edmondson@ed.ac.uk" },
+]
+description = "A procedural gridworld maze requiring completion of temporally extended tasks."
+readme = "README.md"
+requires-python = ">=3.10"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+]
+dependencies = [
+    "gymnasium",
+    "numpy",
+    "pygame",
+]
+
+[project.urls]
+"Homepage" = "https://github.com/Levinin/rescue_gridworld_env"
+"Bug Tracker" = "https://github.com/Levinin/rescue_gridworld_env/issues"
+
+[tool.setuptools.packages.find]
+where = ["."]
+include = ["rescue_gridworld*"]

rescue_gridworld-1.0.0/rescue_gridworld/__init__.py

@@ -0,0 +1,11 @@
+from gymnasium.envs.registration import register
+from .env_constants import *
+from .env import RescueGridworldEnv
+
+# Register the environment
+register(
+    id="RescueGridworld-v0",
+    entry_point="rescue_gridworld.env:RescueGridworldEnv",
+)
+
+__all__ = ["RescueGridworldEnv"]