optimiz-rs/docs/source/installation.md

Installation Guide

Requirements

• Python 3.8 or higher
• Rust 1.70 or higher (for building from source)
• pip

Install from PyPI

Coming soon: OptimizR will be available on PyPI.

pip install optimizr

Install from Source

Step 1: Clone Repository

git clone https://github.com/ThotDjehuty/optimiz-r.git
cd optimiz-r

Step 2: Install Maturin

Maturin is required to build Rust-Python bindings:

pip install maturin

Step 3: Build and Install

Development mode (editable install, useful for development):

maturin develop --release

Production install (creates wheel and installs):

maturin build --release
pip install target/wheels/optimizr-*.whl

Step 4: Verify Installation

import optimizr
print(optimizr.__version__)  # Should print "0.3.0"

Platform-Specific Notes

macOS

If you encounter build errors on macOS:

1. Ensure Xcode Command Line Tools are installed:

   xcode-select --install
   

2. Install Rust via rustup:

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

Windows

1. Install Visual Studio Build Tools (2019 or later)
2. Install Rust via rustup-init.exe
3. Follow standard installation steps

Linux

Requires GCC or Clang:

# Ubuntu/Debian
sudo apt-get install build-essential

# Fedora/RHEL
sudo dnf install gcc gcc-c++

Troubleshooting

Issue: maturin: command not found

Solution: Ensure pip bin directory is in PATH:

export PATH="$HOME/.local/bin:$PATH"  # Linux/macOS

Issue: Rust compiler errors

Solution: Update Rust to latest stable:

rustup update stable

Issue: ImportError when importing optimizr

Solution: Rebuild with correct Python version:

maturin develop --release -i python3.10  # Replace with your Python version