stepopt

Optimisation algorithm implementations in Python

Installation

Clone the repository

git clone https://github.com/AshrithSagar/stepopt.git
cd stepopt

Install uv

Install uv, if not already. Check here for installation instructions.

It is recommended to use uv, as it will automatically install the dependencies in a virtual environment. If you don't want to use uv, skip to the next step.

TL;DR: Just run

curl -LsSf https://astral.sh/uv/install.sh | sh

Install the package

The dependencies are listed in the pyproject.toml file.

Install the package in editable mode (recommended):

# Using uv
uv sync

# Or with pip
pip3 install -e .

License

This project falls under the MIT License.