CyxWiz LogoCyxWiz
DocsInstallation

Installation

Get CyxWiz up and running on your system. This guide covers installation for all components.

Prerequisites

# Check required tools
cmake --version      # 3.20+
git --version        # 2.0+
rustc --version      # 1.70+
python --version     # 3.8+

System Requirements

Minimum
  • OS: Windows 10, macOS 10.15, Ubuntu 18.04
  • CPU: 4 cores
  • RAM: 8 GB
  • GPU: OpenGL 3.3 compatible
  • Storage: 500 MB (application)
Recommended
  • OS: Windows 11, macOS 13, Ubuntu 22.04
  • CPU: 8+ cores
  • RAM: 16+ GB
  • GPU: NVIDIA RTX series (CUDA acceleration)
  • Storage: 10+ GB (with datasets)

Clone and Build

# Clone repository
git clone https://github.com/CYXWIZ-Lab/CYXWIZ.git
cd CyxWiz

# Run setup script (installs dependencies)
./scripts/setup.sh    # Linux/macOS
# or
setup.bat             # Windows (Developer Command Prompt)

# Build everything
./scripts/build.sh    # Linux/macOS
# or
build.bat             # Windows

Running Components

CyxWiz EngineDesktop Client
# Linux/macOS
./build/linux-release/bin/cyxwiz-engine

# Windows
.\build\windows-release\bin\cyxwiz-engine.exe
Server NodeCompute Worker
# Linux/macOS
./build/linux-release/bin/cyxwiz-server-node

# Windows
.\build\windows-release\bin\cyxwiz-server-node.exe
Central ServerOrchestrator
cd cyxwiz-central-server
cargo run --release

Platform-Specific Instructions

Windows
  1. Install Visual Studio 2022 with C++ workload
  2. Install CMake (3.20+) and add to PATH
  3. Install Rust via rustup
  4. Install Python 3.8+ and add to PATH
  5. Open Developer Command Prompt for VS 2022
  6. Run setup.bat then build.bat
Linux (Ubuntu/Debian)
# Install dependencies
sudo apt update
sudo apt install -y build-essential cmake git python3 python3-pip

# Install Rust
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

# For GPU support (optional)
sudo apt install -y nvidia-cuda-toolkit

# Build
./scripts/setup.sh && ./scripts/build.sh
macOS
# Install Xcode Command Line Tools
xcode-select --install

# Install Homebrew (if not installed)
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

# Install dependencies
brew install cmake python@3.11

# Install Rust
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

# Build
./scripts/setup.sh && ./scripts/build.sh

GPU Setup (Optional)

NVIDIA CUDA

  1. Download and install NVIDIA drivers (latest)
  2. Install CUDA Toolkit 11.0+ from nvidia.com
  3. Verify installation: nvcc --version

Verify GPU Detection

import cyxwiz as cyx

# Check CUDA availability
print(cyx.device.cuda_available())  # Should be True

# List devices
devices = cyx.device.list_devices()
for d in devices:
    print(f"{d.id}: {d.name} ({d.type})")

Troubleshooting

"CUDA not available"
  1. Verify NVIDIA driver is installed
  2. Check CUDA toolkit installation
  3. Ensure ArrayFire was built with CUDA support
"Module not found"
# Ensure Python bindings are built
cmake --build build/linux-release --target pycyxwiz

# Add to PYTHONPATH
export PYTHONPATH=$PYTHONPATH:./build/linux-release/python
"Out of memory"
  • Reduce batch size in training
  • Clear cache: cyx.device.empty_cache()
  • Use mixed precision training