Installation

For Users

Once the package is published, installation will be straightforward:

Via pip (when available on PyPI):

pip install low-rank-toolbox

Via conda (when available on conda-forge):

conda install -c conda-forge low-rank-toolbox

Note

The package is currently under development. For now, please use the developer installation method below.

For Developers

To contribute to the development or modify the package:

  1. Clone the repository:

    git clone https://github.com/BenjaminCarrel/low-rank-toolbox.git
cd low-rank-toolbox

  2. Create the conda environment:

    conda env create -f environment.yml
conda activate low-rank-dev

    This will install all necessary dependencies, including development tools like pytest.

  3. Install in editable mode:

    pip install -e .

    Any changes you make in the src/ directory will be immediately available without needing to reinstall.

Verifying the Installation

Run the comprehensive test suite (1000+ tests):

pytest

All tests should pass. If you encounter any issues, please open an issue.

Requirements

Core Dependencies:

  • Python >= 3.10

  • NumPy >= 1.21

  • SciPy >= 1.7

Development Dependencies:

  • pytest >= 8.3.5

  • sphinx >= 7.0 (for documentation)

  • sphinx_rtd_theme (for documentation)

See environment.yml and pyproject.toml for complete dependency information.