Installation Guide

Overview

SDCStudio is a cloud-based SaaS platform for creating SDC4-compliant data models. This guide covers accessing the platform and, for developers, setting up a local development environment.

Cloud SaaS Access (Primary Method)

The easiest way to use SDCStudio is through our hosted cloud platform. No installation, configuration, or infrastructure management required.

Getting Started

Visit SDCStudio: Navigate to https://sdcstudio.axius-sdc.com
Sign Up: Click "Sign Up" or "Continue with Google" for OAuth authentication
Verify Email: Check your inbox for a verification email and click the confirmation link
Select a Plan: Choose from our subscription plans:
Basic ($29.99/month): Perfect for individuals and small projects
Team ($129.99/month): For small teams with collaborative features
Pro ($799/month): For larger teams and growing businesses
Enterprise: Custom pricing - contact sales for advanced features
Complete Stripe Checkout:
60-day free trial included with all paid plans
Credit card required to start trial (no charges for 60 days)
Cancel anytime before trial ends to avoid charges
Start Building: Access the dashboard and create your first SDC4 data model

Browser Requirements

SDCStudio requires a modern browser:

Chrome/Edge: Version 90 or higher (recommended)
Firefox: Version 88 or higher
Safari: Version 14 or higher

JavaScript Required: SDCStudio is a React-based single-page application that requires JavaScript.

System Requirements

Minimum: - Internet Connection: Broadband (1 Mbps or faster) - Screen Resolution: 1366x768 or higher - RAM: 4GB

Recommended: - Internet Connection: High-speed (10 Mbps or faster) - Screen Resolution: 1920x1080 or higher - RAM: 8GB or more

What's Included in Cloud SaaS

Managed Infrastructure: No servers, databases, or services to maintain
Automatic Updates: Always running the latest version with new features and security patches
Scalable Resources: Processing power and storage scale automatically with your needs
High Availability: Cloud Run multi-service architecture with auto-scaling (1-10 instances)
Secure Data Storage: Cloud SQL PostgreSQL with automated backups
AI-Powered Features: Google Vertex AI (Gemini 2.0 Flash) for intelligent data modeling
Professional Support: Email support for all subscription tiers

Quick Links

Once you have cloud access, continue with:

Quick Start Guide - Create your first data model in 5 minutes
System Overview - Understand SDCStudio's architecture
User Guides - Learn workflows and advanced features

Advanced Developer Setup (Local Installation)

⚠️ For Developers Only: This section is for developers setting up a local development environment. End users should use the Cloud SaaS platform instead.

When to Use Local Installation

Local installation is appropriate for: - Contributing to SDCStudio: Developing new features or fixing bugs - Custom Deployments: On-premises or private cloud deployments - Offline Development: Working without internet access (with Ollama LLM fallback)

Not recommended for: - End users wanting to create data models (use Cloud SaaS) - Production deployments (use our managed cloud platform)

Local Installation (Developers)

If you're running a local instance of SDCStudio for development or on-premises deployment:

Prerequisites

Docker: Version 20.10 or higher
Docker Compose: Version 2.0 or higher
Git: For cloning the repository
Python: 3.11 or higher (for hybrid development)

Quick Start with Docker

Clone the Repository: bash git clone https://github.com/Axius-SDC/SDCStudio.git cd SDCStudio
Configure Environment: bash cp env.example .env # Edit .env with your configuration
Start the Stack: bash docker-compose up -d --build
Access SDCStudio:
Web Interface: http://localhost:8000
Admin Panel: http://localhost:8000/admin

Hybrid Development Setup

For local development with live code reloading:

Start Infrastructure: bash docker-compose up -d db redis fuseki
Install Python Dependencies: bash cd src pip install -r requirements.txt
Run Database Migrations: bash python manage.py migrate
Create Superuser: bash python manage.py createsuperuser
Start Development Server: ```bash # Django web server python manage.py runserver 0.0.0.0:8001

# In separate terminal: Celery worker celery -A sdcstudio worker -l info -P solo

# In separate terminal: Celery beat (scheduler) celery -A sdcstudio beat -l info

# In separate terminal: Daphne (WebSocket support) daphne -b 0.0.0.0 -p 8000 sdcstudio.asgi:application ```

Service Endpoints

Once running, you can access:

Django (dev): http://localhost:8001
Django (prod): http://localhost:8000
Fuseki SPARQL: http://localhost:3030
PostgreSQL: localhost:5432
Redis: localhost:6379

Configuration

Environment Variables

Key environment variables in .env:

# Database
POSTGRES_DB=sdcstudio
POSTGRES_USER=sdcstudio
POSTGRES_PASSWORD=your_secure_password
POSTGRES_HOST=db
POSTGRES_PORT=5432

# Redis
REDIS_HOST=redis
REDIS_PORT=6379

# Django
SECRET_KEY=your_secret_key_here
DEBUG=False
ALLOWED_HOSTS=localhost,127.0.0.1

# LLM Configuration
OLLAMA_BASE_URL=http://ollama:11434
DEFAULT_LLM_MODEL=llama3

# Sentry (optional)
SENTRY_DSN=your_sentry_dsn_here
ENVIRONMENT=development

LLM Configuration

SDCStudio uses AI for intelligent data processing. Configure your LLM provider:

Option 1: Vertex AI (Production, Recommended) ✅

# In .env
LLM_PROVIDER=vertex_ai
EMBEDDING_PROVIDER=vertex_ai
GCP_PROJECT_ID=your-gcp-project-id
VERTEX_AI_LOCATION=us-central1
GOOGLE_APPLICATION_CREDENTIALS=/app/.secrets/gcp-service-account.json

Option 2: Ollama (Local Development Only)

# In .env
LLM_PROVIDER=ollama
OLLAMA_BASE_URL=http://host.docker.internal:11434

# Start Ollama on host (not in Docker)
ollama serve

# Pull a model
ollama pull gemma3:12b

⚠️ Note: Ollama is legacy and only supported for local development. Production deployments use Vertex AI.

See LLM Configuration Guide for detailed setup.

Verification

Test Your Installation

Web Interface: Navigate to http://localhost:8000
Sign In: Use your superuser credentials
Create a Project: Click "Create Project" and verify it works
Upload Test File: Upload a small CSV file to test processing
Check Services: ```bash # Check running containers docker-compose ps

# Check logs docker-compose logs -f web docker-compose logs -f celery ```

Common Issues

Port Already in Use:

# Check what's using port 8000
lsof -i :8000

# Stop the conflicting service or change SDCStudio port

Database Connection Failed:

# Verify PostgreSQL is running
docker-compose ps db

# Check database logs
docker-compose logs db

Celery Not Processing:

# Check Redis connection
docker-compose ps redis

# Check Celery worker logs
docker-compose logs celery

Next Steps

Now that SDCStudio is installed:

Quick Start Guide - Create your first data model
System Overview - Understand the platform architecture
User Guides - Learn key workflows and features

Getting Help

Documentation Issues: Check the troubleshooting guide
Local Setup: See the developer documentation
Support: Contact support@axius-sdc.com

Ready to start? Continue with the Quick Start Guide to create your first data model.