rlaopt

A package containing implementations of randomized linear algebra-based optimization algorithms for scientific computing and optimization.

Warning

This package is under active development. The API may change frequently, and the code may not be stable. Use at your own risk.

Installation

Install the latest release from PyPI with pip:

pip install rlaopt

Or add it to a uv-managed project:

uv add rlaopt

Development

Install uv, clone this repository, and create the locked development environment with:

uv sync

Run commands inside the locked environment with uv run, for example:

uv run pytest

Releasing

The version number in pyproject.toml is the single source of truth. Maintainers prepare a release branch using uv version X.Y.Z --no-sync, merge it into main, and publish a GitHub Release tagged vX.Y.Z. Publishing the GitHub Release validates, attests, and uploads the package to PyPI through Trusted Publishing.

See RELEASING.md for the complete process.

Citation

If you find our work useful, please consider citing our paper:

TODO: add bibtex citation

License

This project is licensed under the Apache License 2.0 - see the LICENSE file for details.