Special Matrices (spmat)

A collection of tools for special matrices with optimized implementations for scientific computing.

Features

Currently includes:

• ILMat: Identity plus positive semi-definite (PSD) low-rank matrix
• DLMat: Diagonal plus positive semi-definite (PSD) low-rank matrix
• BDLMat: Block diagonal plus low-rank matrix

Installation

From PyPI (Recommended)

pip install spmat

From Source

Clone the repository and install:

git clone https://github.com/ihmeuw-msca/spmat.git
cd spmat
pip install -e .

Requirements

• Python >= 3.10, < 3.14
• NumPy
• SciPy

Development

To set up the development environment:

git clone https://github.com/ihmeuw-msca/spmat.git
cd spmat
pip install -e ".[dev]"

Run tests:

pytest

License

This project is licensed under the BSD-2-Clause License - see the LICENSE file for details.