Installation

Requirements

• Python: 3.10 - 3.12
• Dependencies: numpy, scipy, scikit-learn

Quick Install

pip

pip install git+https://github.com/Anselmoo/useful-optimizer

uv (recommended)

uv add git+https://github.com/Anselmoo/useful-optimizer

poetry

poetry add git+https://github.com/Anselmoo/useful-optimizer

Development Installation

For contributing or local development:

# Clone the repository
git clone https://github.com/Anselmoo/useful-optimizer.git
cd useful-optimizer

# Install with uv (recommended)
uv sync

# Or with pip
pip install -e ".[dev]"

Optional Dependencies

Visualization Support

For benchmark visualization capabilities:

# With pip
pip install git+https://github.com/Anselmoo/useful-optimizer[visualization]

# With uv
uv add git+https://github.com/Anselmoo/useful-optimizer --extra visualization

Benchmark Support

For running benchmark suites with advanced plotting:

# With pip
pip install git+https://github.com/Anselmoo/useful-optimizer[benchmark]

# With uv
uv add git+https://github.com/Anselmoo/useful-optimizer --extra benchmark

Verifying Installation

After installation, verify everything works:

# Basic import test
from opt import ParticleSwarm
from opt.benchmark.functions import shifted_ackley

# Quick optimization test
optimizer = ParticleSwarm(
    func=shifted_ackley,
    lower_bound=-2.768,
    upper_bound=2.768,
    dim=2,
    max_iter=50
)

best_solution, best_fitness = optimizer.search()
print(f"Installation verified! Best fitness: {best_fitness:.6f}")

Troubleshooting

ImportError: No module named 'opt'

Ensure the package is installed in your active Python environment:

pip list | grep useful-optimizer

NumPy Version Conflicts

If you encounter NumPy compatibility issues:

pip install numpy>=1.26.4

SciPy Missing

Some classical optimizers require SciPy:

pip install scipy>=1.12.0