⚙️ Development Setup Guide

Get the ENV Platform running on your local machine in 15 minutes

0

Prerequisites

Make sure you have these installed before starting:

Docker Desktop v20.10+
Python v3.10+
Node.js v18+ (Optional)
Unity Hub 2022.3 LTS
Git Latest
CUDA 11.8+ (GPU only)
1

Clone the Repository

Get the ENV platform codebase from GitHub (requires access):

Terminal
git clone https://github.com/abhisekkumar/ethereal-neura-vision.git cd ethereal-neura-vision

⚠️ Private Repository

This repo is private. Make sure you have GitHub access or ask the founder for an invite.

2

Configure Environment Variables

Create a .env file in the project root:

.env
# Core Services NEURO_INGEST_PORT=8001 PREPROCESSING_PORT=8002 BRAIN_ENCODER_PORT=8003 SEMANTIC_ENGINE_PORT=8004 GENERATION_PORT=8005 XR_STREAMING_PORT=8007 SESSION_ORCHESTRATOR_PORT=8000 # GPU Configuration USE_CUDA=true GPU_DEVICE=0 # Model Paths SDXL_MODEL_PATH=./models/stable-diffusion-xl CLIP_MODEL_PATH=./models/clip-vit-large EEGNET_MODEL_PATH=./models/eegnet-weights.pth # API Keys (Optional for mock mode) HUGGINGFACE_TOKEN=your_token_here OPENAI_API_KEY=your_key_here # Database REDIS_HOST=localhost REDIS_PORT=6379 # Logging LOG_LEVEL=INFO LOG_DIR=./logs

✅ Mock Mode Available

Don't have GPU or API keys? The platform runs in mock mode by default for development!

3

Start All Services

Launch the entire ENV platform with Docker Compose:

Terminal
# Start all 7 microservices docker-compose up -d # Check status docker-compose ps # View logs docker-compose logs -f

Services & Ports

Service Port Status Check
Session Orchestrator 8000 curl http://localhost:8000/health
Neuro Ingest 8001 curl http://localhost:8001/health
Preprocessing 8002 curl http://localhost:8002/health
Brain Encoder 8003 curl http://localhost:8003/health
Semantic Engine 8004 curl http://localhost:8004/health
Generation Service 8005 curl http://localhost:8005/health
XR Streaming Gateway 8007 WebSocket connection test
4

Test the Platform

Run a basic end-to-end test:

Python
python tests/integration/test_full_pipeline.py

Or test individual services:

cURL Examples
# Test Session Orchestrator curl http://localhost:8000/api/v1/session/create # Test Image Generation (mock mode) curl -X POST http://localhost:8005/api/v1/generate \ -H "Content-Type: application/json" \ -d '{"prompt": "sunset over mountains", "steps": 20}'
5

Unity VR Client Setup

Set up the Unity VR application:

Terminal
# Navigate to Unity project cd unity/EtherealNeuraVision-VR # Open in Unity Hub open -a "Unity Hub" .

Unity Configuration

1. Unity Version: 2022.3 LTS

2. Required Packages:

  • XR Interaction Toolkit (2.3.0+)
  • OpenXR Plugin (1.7.0+)
  • Universal RP (14.0+)

3. WebSocket Endpoint: ws://localhost:8007/stream

✅ Unity Project Ready

The Unity project is pre-configured. Just open and hit Play to connect to local services!

⚡

Troubleshooting

Common Issues:

Port Already in Use

# Find process using port lsof -ti:8000 # Kill process kill -9 $(lsof -ti:8000)

Docker Out of Memory

Increase Docker memory limit:

Docker Desktop → Settings → Resources → Memory → 8GB+

CUDA Not Available

Set in .env:

USE_CUDA=false

Platform will run in CPU mode (slower but works).

🎉 You're All Set!

Your ENV platform is running. Here's what to do next: