Skip to content

INSTRUCTIONS.md

Latest commit

 

History

History
62 lines (45 loc) · 1.24 KB

INSTRUCTIONS.md

File metadata and controls

62 lines (45 loc) · 1.24 KB

Instructions for Trash Management Simulation

Requirements

Setup

  1. Create and activate a virtual environment:

    On Linux/macOS:

    python3.10 -m venv venv
source venv/bin/activate

    On Windows:

    python3.10 -m venv venv
venv\Scripts\activate

  2. Install the required Python packages:

    source venv/bin/activate
pip install -r doc/requirements.txt

  3. Run the backend (Flask API + Mesa simulation):

    source venv/bin/activate
python src/backend/backend.py

  4. In another terminal, run the 3D visualization:

    source venv/bin/activate
python main.py

A window will open displaying a 3D city grid with autonomous garbage collection vehicles and trash objects.

Controls

  • Arrow keys: Rotate and elevate the camera view.

    • Left/Right: Rotate horizontally
    • Up/Down: Change elevation angle

  • WASD keys: Move the camera position (translate view)

    • W: Move forward
    • S: Move backward
    • A: Move left
    • D: Move right
    • Q: Move down
    • R: Move up

  • Close window: Exit the simulation