AIVEX AnalyticsAIVEX
Getting Started

Getting Started

Prerequisites, installation, and running your first AIVEX research cycle.

What You Are About to Run

AIVEX is a modular AI research runtime. It ingests market data, news, and technical signals, composes them through a governed pipeline, and emits auditable research outputs via the Eye REST API. Each output carries a trace_id, confidence score, and source attribution.

Private Repository Notice: AIVEX is currently a private, internal runtime. Public repository access is not available. To request access to the AIVEX codebase or runtime, contact the team.

Prerequisites

  • Python 3.11 or 3.13
  • MySQL 8.0+ (local or remote)
  • A .env file with the required environment variables (see below)

Installation

After receiving repository access, clone and install dependencies:

git clone <repository-url-provided-by-team>
cd aivex
pip install -r requirements.txt

Environment Configuration

Copy the example environment file:

cp .env.example .env

Required variables:

VariableDescription
DB_HOSTMySQL host (default: localhost)
DB_PORTMySQL port (default: 3306)
DB_NAMEDatabase name
DB_USERDatabase user
DB_PASSWORDDatabase password

Optional variables:

VariableDescription
API_TOKENBearer token for the Eye API (unset = auth disabled)
GOVERNOR_KILL_SWITCHSet to 1 to disable signal emission

Running the System

Start everything (24/7 supervised mode):

python Main.py

Run a single module once (for testing):

python -m watchdog.runners.module_runner news --mode once

Start only the Eye API:

python -m uvicorn eye.main:create_app --factory --port 8001

Verifying the Setup

After starting the system, check the Eye API health endpoint:

curl http://localhost:8001/health

Expected response:

{ "status": "ok", "version": "<current-version>" }

Database Setup

AIVEX automatically creates required tables on first run. For the OHLCV data, run the ingestion script once to populate historical data:

python Ingest_ohlcv.py

Next Steps

Questions? Contact the team →