Quick Start Guide
Get Olytix Core up and running in minutes. This tutorial series will guide you through installation, configuration, and your first semantic queries.
What you'll learn
- Install and configure Olytix Core
- Connect to your data warehouse
- Run semantic queries against SAP sales data
- Explore column-level lineage
Tutorial Series
This quick start is divided into focused parts:
| Part | Title | What You'll Do |
|---|---|---|
| 1 | Overview (this page) | Understand what we're building |
| 2 | Installation | Install dependencies and verify setup |
| 3 | Database Setup | Connect to your warehouse |
| 4 | First Query | Run queries and explore lineage |
Prerequisites
Before you begin
| Software | Version | Purpose |
|---|---|---|
| Python | 3.11+ | Runtime environment |
| Git | Latest | Source control |
| curl or httpie | Latest | API testing (optional) |
Database Requirements
The tutorial uses a PostgreSQL data warehouse with SAP gold layer tables:
| Table Type | Examples |
|---|---|
| Dimensions | dim_customer, dim_material, dim_date, dim_sales_org |
| Facts | fact_sales_order_items, fact_billing, fact_deliveries |
Optional: AI Features
For AI-powered natural language queries:
- Google Gemini
- Anthropic Claude
- OpenAI GPT
pip install -e ".[gemini]"
export GOOGLE_API_KEY=your-api-key
pip install -e ".[anthropic]"
export ANTHROPIC_API_KEY=your-api-key
pip install -e ".[openai]"
export OPENAI_API_KEY=your-api-key
What We're Building
By the end of this tutorial, you'll have:
- A running Olytix Core server with API documentation at
http://localhost:8000/docs - The SAP Sales Analytics project loaded with:
- 8 Cubes (sales orders, billing, deliveries, dimensions)
- 46 Measures (revenue, profitability, fulfillment metrics)
- 17 Business KPIs (growth rates, margins, operational metrics)
- Working knowledge of semantic queries and lineage exploration
Project Structure Preview
tutorial/
├── olytix_core_project.yml # Project configuration
├── sources/
│ └── sap_gold.yml # 10 warehouse table definitions
├── cubes/
│ ├── sales_orders.yml # Sales order cube (15 measures)
│ ├── billing.yml # Billing cube (15 measures)
│ └── deliveries.yml # Delivery cube (16 measures)
├── metrics/
│ └── sales_kpis.yml # 17 business KPIs
└── models/
└── *.sql # SQL transformation models