SDECB

Environment Setup Guide

Overview

This guide will help you set up your local development environment for the SDECB AI Discovery Project.

Prerequisites


Installation Steps

1. Clone the Repository (if not already done)

cd /path/to/your/projects
git clone <repository-url>
cd SDECB

2. Create a Virtual Environment

It’s recommended to use a Python virtual environment to isolate dependencies:

# Create virtual environment
python3 -m venv venv

# Activate it
# On macOS/Linux:
source venv/bin/activate

# On Windows:
venv\Scripts\activate

You should see (venv) in your terminal prompt when activated.

3. Install Python Dependencies

pip install -r requirements.txt

This will install:

4. Configure API Keys

Create a .env file in the project root (this file will NOT be committed to git):

cp .env.example .env

Then edit .env and add your actual API keys:

ELEVENLABS_API_KEY=your_actual_elevenlabs_key_here
MISTRAL_API_KEY=your_actual_mistral_key_here
ANTHROPIC_API_KEY=your_actual_anthropic_key_here
OPENAI_API_KEY=your_actual_openai_key_here

Important: Never commit the .env file to git. It’s already in .gitignore.


Running the Demos

Python Scripts

Navigate to the portal/ directory and run Python demos:

cd portal

# Example: Run the bilingual voice assistant
python3 bilingual_voice_assistant.py

# Example: Run the report narrator
python3 report_narrator.py

HTML Demos

HTML demos can be opened directly in your browser:

  1. Navigate to the portal/ directory
  2. Double-click any .html file to open in your default browser
  3. Or use a local web server for better functionality:
# Option 1: Python's built-in server
cd portal
python3 -m http.server 8000

# Then visit: http://localhost:8000/matthieu_digital_twin_pro.html
# Option 2: Node.js http-server (if you have Node installed)
npm install -g http-server
cd portal
http-server -p 8000

Note: HTML demos currently have placeholder API keys. For production use, you’ll need to implement server-side API key management (see ROADMAP.md).


Testing

Run the test suite:

# From project root
pytest

# Or from portal directory
cd portal
python3 test_demos.py

Troubleshooting

“Module not found” errors

Make sure you’ve activated your virtual environment and installed dependencies:

source venv/bin/activate  # or venv\Scripts\activate on Windows
pip install -r requirements.txt

API Key errors

  1. Check that your .env file exists and has valid keys
  2. Ensure you’ve copied from .env.example correctly
  3. Verify your API keys are active and have proper permissions

Permission denied errors

Make sure Python scripts are executable:

chmod +x portal/*.py

Next Steps


Security Reminders


Last Updated: January 2026 Python Version Required: 3.9+