Skip to main content

Part 2: Installation

For Everyone 5 min read
What you'll learn
  • Clone the Olytix Core repository
  • Set up a Python virtual environment
  • Install all dependencies
  • Verify the installation

Step 1: Clone the Repository​

git clone https://github.com/your-org/olytix-engine.git
cd olytix-engine

Step 2: Create Virtual Environment​

Choose your preferred method for creating a Python virtual environment:

# Create virtual environment
python3.11 -m venv .venv

# Activate it
source .venv/bin/activate

# Verify Python version
python --version
# Should show: Python 3.11.x or higher

Step 3: Install Dependencies​

pip install -e ".[dev]"

This installs Core Olytix functionality, development tools (pytest, ruff, mypy), and CLI commands.

Step 4: Verify Installation​

Run the version command to confirm everything is working:

olytix-core version

Expected output:

Olytix Core v0.1.0

Verify CLI Commands​

Check that all CLI commands are available:

olytix-core --help

You should see a list of available commands:

Usage: olytix-core [OPTIONS] COMMAND [ARGS]...

  Olytix Core - Unified Analytics Modeling Platform

Commands:
  compile         Compile project artifacts
  describe        Describe a specific artifact
  doctor          Run project diagnostics
  graph           Show dependency graph
  lineage         Explore column-level lineage
  list            List project artifacts
  serve           Start the API server
  test-connection Test warehouse connection
  version         Show version information

Troubleshooting​

Python Version Issues​

If you see errors about Python version:

# Check your Python version
python3 --version

# If not 3.11+, install it:
# macOS with Homebrew
brew install python@3.11

# Ubuntu/Debian
sudo apt install python3.11 python3.11-venv

# Then recreate the virtual environment
rm -rf .venv
python3.11 -m venv .venv
source .venv/bin/activate

Permission Errors​

If you encounter permission errors during installation:

# Make sure you're in the virtual environment
which python
# Should show: /path/to/olytix-engine/.venv/bin/python

# If not, activate it
source .venv/bin/activate

Package Conflicts​

If you have package conflicts:

# Remove and recreate the virtual environment
rm -rf .venv
python3.11 -m venv .venv
source .venv/bin/activate
pip install -e ".[dev]"

Next Step​

Continue to Database Setup

Connect Olytix Core to your data warehouse

Configuration Reference

All configuration options explained

Docker Deployment

Run Olytix Core in containers