Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/deskiziarecords/QUIMERIA-HYPERION/llms.txt

Use this file to discover all available pages before exploring further.

QUIMERIA-HYPERION runs as a single FastAPI/uvicorn process. The backend serves both the REST API and the TradingView frontend from port 8000. The SMK_DIR environment variable must point to the project root so cross-module imports resolve correctly — the provided launchers set this automatically, but manual deployments require it explicitly.
The server never crashes on missing optional dependencies. Modules like jax, ripser, and faiss-cpu degrade gracefully to numpy stubs. You will see [WARN] lines at startup for any missing optional module — these are expected and safe.

​
Prerequisites

  • Python 3.10 or later (3.12+ recommended)
  • pip package manager
  • Node.js 18+ (only if doing frontend development — the dashboard is a single static HTML file in production)

​
Install dependencies

pip install -r requirements.txt

# Optional: GPU acceleration and topology
pip install jax jaxlib ripser faiss-cpu

​
Development

Use development mode when iterating on the pipeline or frontend. The --reload flag restarts the server automatically on file changes.
1

Set the SMK_DIR environment variable

# Linux / macOS
export SMK_DIR=/path/to/QUIMERIA-HYPERION
export PYTHONPATH=$SMK_DIR:$SMK_DIR/backend:$PYTHONPATH

# Windows PowerShell
$env:SMK_DIR = "C:\Users\you\Documents\QUIMERIA-HYPERION"
$env:PYTHONPATH = "$env:SMK_DIR;$env:SMK_DIR\backend;$env:PYTHONPATH"
2

Start the development server

cd backend
python -m uvicorn main:app --host 0.0.0.0 --port 8000 --reload
3

Open the dashboard

Navigate to http://localhost:8000 in your browser. The dashboard includes the TradingView chart, all 14 SMK sensor bars, 6 plugin sensor bars, the execution panel, and live log panels.
Run the AEGIS bridge verification after startup to confirm the stop-loss manager and SchurRouter loaded correctly:
cd backend
python test_bridge.py

​
Linux production (systemd)

The repository ships with a ready-to-use systemd unit file at quimeria.service. It configures SMK_DIR, PYTHONPATH, log redirection, and automatic restart on failure.
1

Edit the service file with your paths

Open quimeria.service and replace the placeholder paths with your actual installation directory and username:
[Unit]
Description=QUIMERIA-HYPERION Sovereign Market Kernel
After=network.target

[Service]
Type=simple
User=youruser
WorkingDirectory=/home/youruser/QUIMERIA-HYPERION/backend
Environment="SMK_DIR=/home/youruser/QUIMERIA-HYPERION"
Environment="PYTHONPATH=/home/youruser/QUIMERIA-HYPERION:/home/youruser/QUIMERIA-HYPERION/backend"
ExecStart=/usr/bin/python3 -m uvicorn main:app \
  --host 0.0.0.0 --port 8000 --workers 1 --log-level info
Restart=on-failure
RestartSec=10
StandardOutput=append:/home/youruser/QUIMERIA-HYPERION/logs/backend.log
StandardError=append:/home/youruser/QUIMERIA-HYPERION/logs/backend.log

[Install]
WantedBy=multi-user.target
2

Install and enable the service

sudo cp quimeria.service /etc/systemd/system/
sudo systemctl daemon-reload
sudo systemctl enable quimeria
3

Start the service

sudo systemctl start quimeria
sudo systemctl status quimeria
4

Verify startup

# Follow the combined backend log
tail -f /home/youruser/QUIMERIA-HYPERION/logs/backend.log

# Check the API is responding
curl http://localhost:8000/api/status

​
Linux launcher script

The scripts/start.sh launcher is an alternative to systemd for development servers or machines without root access. It sets SMK_DIR and PYTHONPATH automatically. 
scripts/start.sh

​
Windows service (NSSM)

NSSM (Non-Sucking Service Manager) runs QUIMERIA-HYPERION as a Windows service that starts with the OS and restarts on failure.
1

Install NSSM

Download NSSM from nssm.cc and place nssm.exe in a directory on your PATH, or reference it by full path.
2

Install the service

Open an administrator Command Prompt and run:
nssm install QuimeriaSMK "C:\Python312\python.exe" "-m uvicorn main:app --host 0.0.0.0 --port 8000 --workers 1"
nssm set QuimeriaSMK AppDirectory "C:\path\to\QUIMERIA-HYPERION\backend"
nssm set QuimeriaSMK AppEnvironmentExtra "SMK_DIR=C:\path\to\QUIMERIA-HYPERION"
nssm set QuimeriaSMK AppEnvironmentExtra "PYTHONPATH=C:\path\to\QUIMERIA-HYPERION;C:\path\to\QUIMERIA-HYPERION\backend"
nssm set QuimeriaSMK AppStdout "C:\path\to\QUIMERIA-HYPERION\logs\backend.log"
nssm set QuimeriaSMK AppStderr "C:\path\to\QUIMERIA-HYPERION\logs\backend.log"
3

Start the service

nssm start QuimeriaSMK
4

Verify the service is running

nssm status QuimeriaSMK
curl http://localhost:8000/api/status

​
Windows launcher script

For development or non-service deployments on Windows, use the provided batch launcher: 
scripts\start.bat

​
SMK_DIR requirement

SMK_DIR is the single most critical environment variable. Without it, smk_pipeline._find_smk_root() cannot locate the project root, module imports fail silently, and the server runs in numpy fallback mode — all 18 detector modules are replaced with numpy stubs that return neutral scores. 
export SMK_DIR=/path/to/QUIMERIA-HYPERION
export PYTHONPATH=$SMK_DIR:$SMK_DIR/backend:$PYTHONPATH

​
Access points after startup

EndpointURL
Dashboardhttp://localhost:8000
REST API (Swagger)http://localhost:8000/docs
Health pinghttp://localhost:8000/api/ping
Full statushttp://localhost:8000/api/status
WebSocket streamws://localhost:8000/ws/stream
WebSocket live feedws://localhost:8000/ws/live

​
Custom port

All launchers support a custom port. The frontend auto-detects the host and port from window.location, so the dashboard works on any port without code changes. 
cd backend
python -m uvicorn main:app --host 0.0.0.0 --port 8080 --reload

Build docs developers (and LLMs) love

Get started for freeTalk to us