Skip to content

Installation Guide

This guide covers different ways to install and set up the Swarmauri SDK for your development environment.

Prerequisites

Requirements

Before installing Swarmauri SDK, ensure you have:

  • Python 3.10 or later
  • pip (Python package installer)
  • Git (for development installation)

Python Version Compatibility

Swarmauri SDK requires Python 3.10 or later. Earlier versions of Python are not supported.

Quick Installation

Using pip

pip install swarmauri

Using Poetry

poetry add swarmauri

Recommended Approach

We recommend using a virtual environment for your projects to avoid dependency conflicts.

Detailed Installation Methods

1. Using pip with Virtual Environment

# Create a new virtual environment
python -m venv swarmauri_env

# Activate the environment
# On macOS/Linux:
source swarmauri_env/bin/activate

# On Windows:
.\swarmauri_env\Scripts\activate

# Install Swarmauri SDK
pip install swarmauri

# Verify installation
python -c "import swarmauri; print(swarmauri.__version__)"

Environment Activation

Remember to activate your virtual environment each time you open a new terminal session.

2. Using Conda

# Create a new conda environment
conda create -n swarmauri_env python=3.11

# Activate the environment
conda activate swarmauri_env

# Install pip inside conda environment
conda install pip

# Install Swarmauri SDK
pip install swarmauri

# Optional: Install Jupyter if needed
conda install jupyter

Python Version

Python 3.11 is recommended for optimal performance with Swarmauri SDK.

3. Jupyter Notebook Setup

# Create a new conda environment with Jupyter
conda create -n swarmauri_jupyter python=3.11 jupyter

# Activate the environment
conda activate swarmauri_jupyter

# Install Swarmauri SDK
pip install swarmauri

# Launch Jupyter Notebook
jupyter notebook

Verification

Verify your installation by running:

import swarmauri

# Check version
print(swarmauri.__version__)

Troubleshooting

If you encounter an ImportError or incorrect version number:

  • Ensure you've activated the correct environment
  • Verify the installation completed successfully
  • Check for any error messages during installation

Development Installation

For Contributors

If you're planning to contribute to Swarmauri SDK or need the latest development version:

# Clone the repository
git clone https://github.com/swarmauri/swarmauri-sdk.git

# Navigate to the project directory
cd swarmauri-sdk

# Install in development mode
pip install -e .

Next Steps

After installation:

  1. Check out our Quickstart Guide
  2. Review API Documentation
  3. Try our Courses
  4. Join our Community

Getting Started

The Quickstart Guide is the best place to begin your journey with Swarmauri SDK.

Getting Help

If you run into issues:

  1. Check our FAQ
  2. Visit our GitHub Issues
  3. Join our Discord Community

Need Help?

If you have questions or need assistance, join our Discord community or check out our FAQ.