swarm-squad 0.1.5

Swarm Squad: A simulation framework for multi-agent systems.

Swarm Squad

A simulation framework for multi-agent systems.

  

---

✨ Key Features

1. Agent Simulation: Swarm Squad allows you to simulate the behavior of multiple agents in a controlled environment. This is essential for testing how agents interact with each other and their environment.

2. Scalability: It should be able to handle a large number of agents simultaneously. This is important for testing the system's performance under various load conditions.

3. Behavior Specification: Swarm Squad may include a way to define and specify the expected behavior of agents. This can be used to evaluate whether the agents are acting as intended.

4. Environment Modeling: It provides tools for creating and managing the environment in which the agents operate. This could be a physical or virtual space with obstacles, goals, or other entities.

5. Metrics and Analytics: The framework likely offers mechanisms for collecting and analyzing data on agent behavior. This could include metrics like speed, coordination, efficiency, or any other relevant performance indicators.

6. Customization and Extensibility: It should allow users to customize and extend the framework to suit their specific needs. This might involve adding new types of agents, modifying the environment, or defining custom evaluation criteria.

7. Visualization and Reporting: Swarm Squad may include tools for visualizing the simulation in real-time or for generating reports after a simulation run. This helps in understanding and communicating the results.

8. Integration with Other Tools: It may have the capability to integrate with other software or libraries commonly used in multi-agent systems development, such as reinforcement learning libraries, communication protocols, or visualization tools.

9. Support for Various Types of Agents: Swarm Squad should be versatile enough to support different types of agents, such as robots, drones, and autonomous vehicles.

10. Documentation and Support: Proper documentation and support resources are essential for users to effectively utilize the framework.

---

🚀 Getting Started

Get uv and create a virtual environment.

uv venv --python 3.10
source .venv/bin/activate
uv pip install swarm-squad

To run the application, simply type:

swarm-squad
# or
swarm-squad --help

---

👨‍💻 Development Setup

1. Clone the repository and navigate to project folder:

   git clone https://github.com/Sang-Buster/Swarm-Squad
   cd Swarm-Squad
   

2. Install uv first:

   # macOS/Linux
   curl -LsSf https://astral.sh/uv/install.sh | sh
   

   # Windows
   powershell -c "irm https://astral.sh/uv/install.ps1 | iex"
   

3. Create a virtual environment at Swarm-Squad/.venv/:

   uv venv --python 3.10
   

4. Activate the virtual environment:

   # macOS/Linux
   source .venv/bin/activate
   

   # Windows
   .venv\Scripts\activate
   

5. Install the required packages:

   uv pip install -e .
   

6. Set up environment variables:

   # Copy the example environment file
   cp .env.example .env
   

   • You can get a MAPBOX_ACCESS_TOKEN by signing up at https://www.mapbox.com/
   • Update the OLLAMA_API_URL if your Ollama instance is running on a different address
   • Update the DATABASE_PATH if you want to use a custom database file

7. Install ruff and pre-commit:

   uv pip install ruff pre-commit
   

   • ruff is a super fast Python linter and formatter.
   • pre-commit helps maintain code quality by running automated checks before commits are made.

8. Install git hooks:

   pre-commit install --hook-type commit-msg --hook-type pre-commit --hook-type pre-push
   

   These hooks perform different checks at various stages:

   • commit-msg: Ensures commit messages follow the conventional format
   • pre-commit: Runs Ruff linting and formatting checks before each commit
   • pre-push: Performs final validation before pushing to remote

9. Code Linting:

   ruff check
   ruff check --fix
   ruff check --select I
   ruff check --select I --fix
   ruff format
   

10. Run the application:

uv run src/swarm_squad/app.py

---

📝 File Structure

📂Swarm Squad
 ┣ 📂src                         // Source Code
 ┃ ┗ 📦swarm_squad                  // 
 ┃ ┃ ┣ 📂assets                     // Static assets (CSS, images, favicon, etc.)
 ┃ ┃ ┃ ┣ 📂css                      // CSS files
 ┃ ┃ ┃ ┣ 📂js                       // JavaScript files
 ┃ ┃ ┃ ┣ 📂models                   // Model files
 ┃ ┃ ┃ ┣ 📄favicon.ico              // Favicon
 ┃ ┃ ┃ ┗ 📄favicon.png              // Favicon
 ┃ ┃ ┣ 📂cli                        // CLI commands
 ┃ ┃ ┣ 📂components                 // Reusable UI components
 ┃ ┃ ┣ 📂data                       // Database files
 ┃ ┃ ┣ 📂pages                      // Page components and routing
 ┃ ┃ ┣ 📂scripts                    // Simulation and algorithm scripts
 ┃ ┃ ┣ 📂utils                      // Utility functions and helpers
 ┃ ┃ ┣ 📂cli                        // CLI commands
 ┃ ┃ ┣ 📄app.py                     // Entry point
 ┃ ┃ ┗ 📄core.py                    // Dash app core
 ┣ 📄.env.example                // Template for environment variables
 ┣ 📄.gitignore                  // Git ignore patterns (env, cache, database)
 ┣ 📄.pre-commit-config.yaml     // Pre-commit hooks (ruff, commit message)
 ┣ 📄.pre-commit_msg_template.py // Commit message format validator
 ┣ 📄.python-version             // Python version
 ┣ 📄LICENSE                     // MIT License
 ┣ 📄README.md                   // Project documentation
 ┣ 📄pyproject.toml              // Project configuration
 ┗ 📄uv.lock                     // Lock file