Skip to main content

Installation

For Everyone

This guide covers all installation methods for Olytix Core, from simple pip installs to production-ready Kubernetes deployments.

Requirements​

System Requirements​

ComponentMinimumRecommended
Python3.11+3.12+
Memory2 GB8 GB
Disk500 MB2 GB
CPU2 cores4+ cores

Supported Operating Systems​

  • Linux: Ubuntu 20.04+, Debian 11+, RHEL 8+, Amazon Linux 2
  • macOS: 12 (Monterey) or later
  • Windows: Windows 10/11 with WSL2

Installation Methods​

The simplest way to install Olytix Core:

# Install Olytix Core
pip install olytix-core

# Verify installation
olytix-core --version

Output:

Olytix Core version 1.0.0
Python 3.12.0
Platform: linux-x86_64

Installing with Extras​

Olytix Core supports optional dependencies for different use cases:

# Install with all warehouse adapters
pip install "olytix-core[warehouses]"

# Install with specific warehouse
pip install "olytix-core[snowflake]"
pip install "olytix-core[bigquery]"
pip install "olytix-core[databricks]"

# Install with AI features
pip install "olytix-core[ai]"

# Install everything
pip install "olytix-core[all]"

Method 2: pipx (Isolated Installation)​

For a clean, isolated installation:

# Install pipx if you don't have it
pip install pipx
pipx ensurepath

# Install Olytix Core
pipx install olytix-core

# Verify
olytix-core --version

Method 3: Docker​

For containerized deployments:

# Pull the official image
docker pull olytix/olytix-core:latest

# Run Olytix Core
docker run -it --rm \
  -v $(pwd):/workspace \
  -p 8000:8000 \
  olytix/olytix-core:latest

# Or use docker-compose
docker-compose up -d

docker-compose.yml:

version: '3.8'

services:
  olytix-core:
    image: olytix/olytix-core:latest
    ports:
      - "8000:8000"
    volumes:
      - ./project:/workspace
    environment:
      - OLYTIX_DATABASE__HOST=postgres
      - OLYTIX_DATABASE__PORT=5432
      - OLYTIX_DATABASE__USER=${DB_USER}
      - OLYTIX_DATABASE__PASSWORD=${DB_PASSWORD}
    depends_on:
      - postgres

  postgres:
    image: postgres:15
    environment:
      POSTGRES_USER: ${DB_USER}
      POSTGRES_PASSWORD: ${DB_PASSWORD}
      POSTGRES_DB: analytics
    volumes:
      - postgres_data:/var/lib/postgresql/data

volumes:
  postgres_data:

Method 4: From Source​

For development or customization:

# Clone the repository
git clone https://github.com/olytix/olytix-core.git
cd olytix-core

# Create virtual environment
python -m venv .venv
source .venv/bin/activate  # On Windows: .venv\Scripts\activate

# Install in development mode
pip install -e ".[dev]"

# Verify
olytix-core --version

Post-Installation Setup​

1. Verify Installation​

Run the diagnostic command:

olytix-core doctor

Expected output:

Olytix Core Diagnostic Report
======================
✓ Python version: 3.12.0 (compatible)
✓ Olytix Core version: 1.0.0
✓ Dependencies: All satisfied
✓ Configuration: Valid
✓ Adapters available:
  - PostgreSQL
  - Snowflake
  - BigQuery
  - Databricks
  - Redshift
  - DuckDB

All checks passed!

2. Configure Shell Completion​

Enable tab completion for your shell:

# Bash
olytix-core completion bash >> ~/.bashrc

# Zsh
olytix-core completion zsh >> ~/.zshrc

# Fish
olytix-core completion fish > ~/.config/fish/completions/olytix-core.fish

3. Set Up Environment Variables​

Create a .env file or export variables:

# Database credentials
export OLYTIX_DB_USER=your_username
export OLYTIX_DB_PASSWORD=your_password

# Or use a .env file
cat > .env << 'EOF'
OLYTIX_DB_USER=your_username
OLYTIX_DB_PASSWORD=your_password
OLYTIX_LOG_LEVEL=INFO
EOF

Warehouse-Specific Setup​

PostgreSQL​

# Install PostgreSQL adapter (included by default)
pip install "olytix-core[postgresql]"

# Test connection
olytix-core test-connection --type postgresql \
  --host localhost \
  --port 5432 \
  --database analytics \
  --user $OLYTIX_DB_USER \
  --password $OLYTIX_DB_PASSWORD

Snowflake​

# Install Snowflake adapter
pip install "olytix-core[snowflake]"

# Set Snowflake credentials
export SNOWFLAKE_ACCOUNT=your_account
export SNOWFLAKE_USER=your_user
export SNOWFLAKE_PASSWORD=your_password
export SNOWFLAKE_WAREHOUSE=your_warehouse
export SNOWFLAKE_DATABASE=your_database

BigQuery​

# Install BigQuery adapter
pip install "olytix-core[bigquery]"

# Set up authentication
export GOOGLE_APPLICATION_CREDENTIALS=/path/to/service-account.json

# Or use gcloud
gcloud auth application-default login

Databricks​

# Install Databricks adapter
pip install "olytix-core[databricks]"

# Set Databricks credentials
export DATABRICKS_HOST=https://your-workspace.cloud.databricks.com
export DATABRICKS_TOKEN=your_personal_access_token
export DATABRICKS_HTTP_PATH=/sql/1.0/warehouses/your_warehouse_id

Redshift​

# Install Redshift adapter
pip install "olytix-core[redshift]"

# Set Redshift credentials
export REDSHIFT_HOST=your-cluster.region.redshift.amazonaws.com
export REDSHIFT_PORT=5439
export REDSHIFT_DATABASE=your_database
export REDSHIFT_USER=your_user
export REDSHIFT_PASSWORD=your_password

DuckDB​

# Install DuckDB adapter
pip install "olytix-core[duckdb]"

# DuckDB works with local files
# No additional setup required

Upgrading Olytix Core​

Using pip​

# Upgrade to latest version
pip install --upgrade olytix-core

# Upgrade to specific version
pip install olytix-core==1.2.0

# Check current version
olytix-core --version

Using Docker​

# Pull latest image
docker pull olytix/olytix-core:latest

# Or specific version
docker pull olytix/olytix-core:1.2.0

Migration After Upgrade​

After upgrading, run the migration check:

olytix-core migrate --check

# If changes needed
olytix-core migrate --apply

Troubleshooting Installation​

Common Issues​

Python Version Mismatch​

Error: Python 3.9 is not supported. Requires Python 3.11+

Solution: Install Python 3.11 or later:

# Ubuntu/Debian
sudo apt update && sudo apt install python3.11

# macOS with Homebrew
brew install python@3.12

# Windows
# Download from python.org

Permission Denied​

Error: Permission denied: '/usr/local/lib/python3.12/site-packages'

Solution: Use a virtual environment or --user flag:

# Option 1: Virtual environment (recommended)
python -m venv .venv && source .venv/bin/activate
pip install olytix-core

# Option 2: User installation
pip install --user olytix-core

Missing System Dependencies​

Error: Could not build wheels for pyarrow

Solution: Install build dependencies:

# Ubuntu/Debian
sudo apt install build-essential cmake

# macOS
xcode-select --install

# Or install pre-built wheel
pip install --prefer-binary olytix-core

SSL Certificate Errors​

Error: SSL: CERTIFICATE_VERIFY_FAILED

Solution:

# macOS
/Applications/Python\ 3.12/Install\ Certificates.command

# Or upgrade certifi
pip install --upgrade certifi

Getting Help​

If you encounter issues:

  1. Check the FAQ
  2. Search GitHub Issues
  3. Join our Discord community
  4. Contact support@olytix.net

Next Steps​

Now that Olytix Core is installed:

  1. Initialize your first project →
  2. Define your first cube →
  3. Run your first query →