Installation Guide: SynaptiQ Systems
Installation Guide: SynaptiQ Systems
Prerequisites
Before installing SynaptiQ Systems, ensure you have the following:
Python 3.9 or later Download and install from python.org.
Git Clone the repository using Git. Install from git-scm.com.
Package Manager (pip) pip is already included with Python. If missing, install via:
bashCopy codepython -m ensurepip --upgrade
Redis (for task queues and swarm consensus) Install Redis:
bashCopy codesudo apt-get install redis
Or download it from redis.io.
MongoDB, Neo4j, Qdrant, or SQLite (Optional) Install depending on your project needs:
MongoDB: Install MongoDB
Neo4j: Install Neo4j
Qdrant: Install Qdrant
SQLite: Pre-installed on most systems.
Step 1: Clone the Repository
Clone the SynaptiQ Systems repository:
bashCopy codegit clone https://github.com/<your-organization>/synaptiq.git
cd synaptiq
Step 2: Set Up a Virtual Environment
It’s recommended to use a virtual environment to avoid dependency conflicts:
bashCopy codepython -m venv venv
source venv/bin/activate # On Windows: venv\Scripts\activate
Step 3: Install Dependencies
Install the required packages using pip:
bashCopy codepip install -r requirements.txt
Step 4: Configure Environment Variables
Set up your environment variables for blockchain integrations, IPFS, and other services. Create a .env
file in the root directory:
bashCopy code# Blockchain
SOLANA_WALLET_PATH=/path/to/solana-wallet.json
ETHEREUM_WALLET_PRIVATE_KEY=your_ethereum_private_key_here
# Redis
REDIS_HOST=localhost
REDIS_PORT=6379
# MongoDB
MONGODB_URI=mongodb://localhost:27017
Step 5: Start Redis
Ensure Redis is running:
bashCopy coderedis-server
Step 6: Run SynaptiQ Systems
Launch the framework and start interacting with your swarm:
bashCopy codepython examples/swarm_simulation.py
Optional: Additional Integrations
MongoDB: Ensure your MongoDB server is running:
bashCopy codemongod
Neo4j: Start Neo4j from your terminal or GUI:
bashCopy codeneo4j start
Qdrant: Start Qdrant on your local server or cloud instance.
SQLite: No additional setup required; SQLite is file-based and ready to use.
Troubleshooting
Issue: ModuleNotFoundError
Solution: Ensure all dependencies are installed via
pip install -r requirements.txt
.Issue: redis.exceptions.ConnectionError
Solution: Ensure Redis is running on the correct host and port.
Issue: FileNotFoundError for wallet paths
Solution: Verify that the
.env
file is correctly configured and the paths are valid.
Last updated