Spatial-Gym 0.1.1__tar.gz

spatial_gym-0.1.1/.github/workflows/publish.yml

@@ -0,0 +1,57 @@
+name: Publish Python Package
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch:  # Allow manual triggering
+
+permissions:
+  contents: read
+  id-token: write
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/Spatial-Gym
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      
+      - name: Check Git Version
+        run: git --version
+      
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.9'
+      
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install build hatchling
+      
+      - name: Extract version from tag
+        run: |
+          # Extract version from git tag (format: v0.0.0 or 0.0.0)
+          PACKAGE_VERSION=$(echo $GITHUB_REF | sed 's/refs\/tags\///' | sed 's/^v//')
+          echo "PACKAGE_VERSION=$PACKAGE_VERSION" >> $GITHUB_ENV
+          echo "Extracted version: $PACKAGE_VERSION"
+      
+      - name: Update version in pyproject.toml
+        run: |
+          # Update the version field in pyproject.toml
+          sed -i "s/^version = \".*\"/version = \"$PACKAGE_VERSION\"/" pyproject.toml
+          echo "Updated pyproject.toml with version $PACKAGE_VERSION"
+          # Verify the change
+          grep "^version = " pyproject.toml
+      
+      - name: Build package
+        run: |
+          python -m build
+      
+      - name: Publish package to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

spatial_gym-0.1.1/.github/workflows/tests.yml

@@ -0,0 +1,126 @@
+name: Tests
+
+on:
+  push:
+    branches: [ main, develop ]
+  pull_request:
+    branches: [ main, develop ]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+        python-version: ['3.9', '3.10', '3.11']
+    
+    steps:
+      - uses: actions/checkout@v4
+      
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+      
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e ".[test]"
+      
+      - name: Run basic environment tests
+        run: |
+          pytest tests/test_environment.py -v --tb=short
+      
+      - name: Run random agent tests
+        run: |
+          pytest tests/test_random_agent.py -v --tb=short
+      
+      - name: Run predefined path tests
+        run: |
+          pytest tests/test_predefined_paths.py -v --tb=short
+      
+      - name: Run all tests with coverage
+        run: |
+          pytest tests/ -v --tb=short --cov=Spatial_Gym --cov-report=term-missing
+      
+      - name: Test package installation
+        run: |
+          pip install -e .
+          python -c "import Spatial_Gym; import gymnasium as gym; env = gym.make('Spatial-Gym'); print('✓ Environment created successfully')"
+  
+  integration-test:
+    runs-on: ubuntu-latest
+    needs: test
+    
+    steps:
+      - uses: actions/checkout@v4
+      
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.10'
+      
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e ".[test]"
+      
+      - name: Run extended integration test
+        run: |
+          python -c "
+          import gymnasium as gym
+          import Spatial_Gym
+          
+          print('Running integration test with random agent...')
+          env = gym.make('Spatial-Gym', max_steps=100)
+          
+          # Test multiple episodes
+          for episode in range(5):
+              obs, info = env.reset()
+              done = False
+              steps = 0
+              while not done:
+                  action = env.action_space.sample()
+                  obs, reward, terminated, truncated, info = env.step(action)
+                  done = terminated or truncated
+                  steps += 1
+              print(f'Episode {episode + 1}: {steps} steps')
+          
+          env.close()
+          print('✓ Integration test passed')
+          "
+      
+      - name: Test different configurations
+        run: |
+          python -c "
+          import gymnasium as gym
+          import Spatial_Gym
+          
+          configs = [
+              {'observation': 'new', 'render_mode': None},
+              {'observation': 'SPaRC', 'render_mode': None},
+              {'observation': 'new', 'render_mode': 'llm'},
+              {'observation': 'new', 'traceback': True},
+          ]
+          
+          for i, config in enumerate(configs):
+              print(f'Testing configuration {i + 1}: {config}')
+              env = gym.make('Spatial-Gym', max_steps=50, **config)
+              obs, info = env.reset()
+              
+              for _ in range(10):
+                  action = env.action_space.sample()
+                  obs, reward, terminated, truncated, info = env.step(action)
+                  if terminated or truncated:
+                      break
+              
+              env.close()
+              print(f'✓ Configuration {i + 1} passed')
+          
+          print('✓ All configurations tested successfully')
+          "

spatial_gym-0.1.1/.gitignore

@@ -0,0 +1,10 @@
+__pycache__/
+.env
+Gym_Env_SPaRC.egg-info/
+dist/
+logfiles/
+logfiles_t/
+results_cluster/
+llm_testing/alter_traceback_prompt.txt
+run_agent.py
+run-gym.sbatch

spatial_gym-0.1.1/Final_Product.py

@@ -0,0 +1,39 @@
+import gymnasium as gym
+import pandas as pd
+import Spatial_Gym
+from human_play import play_human
+'''
+This script initializes the Gym environment and runs a sample episode.
+'''
+
+# Initialize the Gym environment with the loaded puzzles
+env = gym.make("Spatial-Gym", render_mode='human', observation='SPaRC', traceback=True, max_steps=1000)
+
+# If you want to play the game using human inputs, use the play_human function. 
+# render_mode can now be set to either 'human' or 'llm' and both will work.
+obs, reward, info = play_human(env, id='aa31d05ed8fdb273')
+env.close()
+
+#print(f"Reward: {reward}, info: {info} , obs: {obs}" )
+
+'''
+# Otherwise, you can run a sample episode automatically by uncommenting the following lines:
+
+# The reset method resets the puzzle and returns the initial observation and info.
+# Has to be called before starting the episode. 
+obs, info = env.reset()
+
+while True:
+    # Sample a random action from the action space
+    # Can be replaced with a specific action if desired.
+    action = env.action_space.sample()
+    
+    # Step the environment with the selected action
+    obs, reward, terminated, truncated, info = env.step(action)
+    
+    # Check if the episode has ended
+    if terminated or truncated:
+        print(f"Reward: {reward}, info: {info}")
+        env.close()
+        break
+'''

spatial_gym-0.1.1/LICENCE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Tobias Kristoffer Mark
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

spatial_gym-0.1.1/MIGRATION_NOTES.md

@@ -0,0 +1,86 @@
+# Migration from SPaRC-Gym to Spatial-Gym
+
+## Overview
+This document summarizes the changes made when migrating from SPaRC-Gym to Spatial-Gym.
+
+## Repository Changes
+- **Old Repository**: `tobiTKM/SPaRC-Gym`
+- **New Repository**: `lkaesberg/Spatial-Gym`
+- **URL**: https://github.com/lkaesberg/Spatial-Gym
+
+## Package Changes
+- **Package Name**: `SPaRC-Gym` → `Spatial-Gym`
+- **Module Name**: `SPaRC_Gym` → `Spatial_Gym`
+- **Version**: `0.2.0` → `1.0.0`
+
+## File Structure Changes
+```
+SPaRC_Gym/           →  Spatial_Gym/
+├── SPaRC_Gym.py     →  Spatial_Gym.py
+├── __init__.py          (updated imports)
+└── register_env.py      (updated registration)
+```
+
+## Code Changes
+All occurrences of `SPaRC` have been replaced with `Spatial` in:
+- Python files (`.py`)
+- Configuration files (`pyproject.toml`, `.yml`)
+- Documentation (`README.md`)
+- Comments and docstrings
+
+## Updated Components
+
+### 1. README.md
+- Rewritten for ACL-style conference submission
+- Added abstract and key features
+- Comprehensive environment specification
+- API reference with examples
+- Citation information (BibTeX format)
+- Enhanced documentation structure
+
+### 2. pyproject.toml
+- Updated package metadata
+- Added keywords and classifiers
+- Enhanced project URLs
+- Updated authors list
+- Bumped version to 1.0.0
+
+### 3. GitHub Actions Pipeline
+- Modernized to latest action versions (v4)
+- Added manual workflow trigger
+- Updated PyPI publishing action
+- Added hatchling to build dependencies
+
+## Usage Changes
+
+### Old Usage
+```python
+import gymnasium as gym
+import SPaRC_Gym
+env = gym.make("SPaRC-Gym", ...)
+```
+
+### New Usage
+```python
+import gymnasium as gym
+import Spatial_Gym
+env = gym.make("Spatial-Gym", ...)
+```
+
+## Installation Changes
+
+### Old
+```bash
+pip install SPaRC-Gym
+```
+
+### New
+```bash
+pip install Spatial-Gym
+```
+
+## Notes
+- Git history was reset (clean start, not a fork)
+- All functionality preserved
+- API remains backward compatible
+- Dataset references (`lkaesberg/SPaRC`) remain unchanged