Installation

Installation Guide

Prerequisites

Required

• Rust 1.83 or higher
• Python 3.10 or higher
• Operating System: Windows 10/11 or Linux

Optional

• Git (for cloning repository)
• Visual Studio Code (recommended IDE)

Step-by-Step Installation

1. Install Rust

Windows:

# Download and run rustup-init.exe
https://rustup.rs/

# Verify installation
rustc --version
cargo --version

Linux:

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
source $HOME/.cargo/env
rustc --version

2. Install Python

Windows:

# Download from python.org or use winget
winget install Python.Python.3.11

# Verify installation
python --version

Linux:

sudo apt update
sudo apt install python3.11 python3.11-venv python3-pip
python3 --version

3. Clone Repository

git clone https://github.com/ChronoCoders/proteus.git
cd proteus

4. Create Virtual Environment

Windows:

python -m venv venv
venv\Scripts\activate

Linux:

python3 -m venv venv
source venv/bin/activate

5. Install Python Dependencies

pip install maturin numpy scikit-learn torch

6. Build Rust Extension

maturin develop --release

7. Verify Installation

python -c "import proteus; print('Proteus installed successfully')"

Troubleshooting

Error: "maturin: command not found"

pip install --upgrade maturin

Error: "Microsoft Visual C++ 14.0 or greater is required"

Windows: Install Visual Studio Build Tools

Error: "Python.h: No such file or directory"

Linux:

sudo apt install python3-dev

Build is slow

Use release mode for faster execution:

maturin develop --release

Next Steps

• Basic Usage Guide
• CLI Reference
• API Documentation