Metadata-Version: 2.4
Name: hyperfold
Version: 0.1.1
Summary: NumPy-first Hyperfold Python API for the Hyperfold HPC library
Author: Lorenzo Fritzsch
License-Expression: LicenseRef-Hyperfold-Freeware
License-File: LICENSE.txt
License-File: THIRD_PARTY_NOTICES.txt
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Project-URL: Documentation, https://www.braketware.com/hyperfold/index.html
Requires-Python: >=3.11
Requires-Dist: numpy>=1.26
Requires-Dist: ml_dtypes>=0.5.3
Description-Content-Type: text/markdown

# Hyperfold

Hyperfold provides numerical linear algebra for Python, with a NumPy-first API
backed by native CPU kernels. Multiply matrices, solve linear systems, compute
eigenvalues, and reuse LU factorisations with real or complex arrays.

## Installation

Requires Python 3.11 or newer.

```bash
python -m pip install hyperfold
```

For CPU and CUDA 13 support on Linux x86_64 with a compatible NVIDIA driver,
install `hyperfold-cuda` instead. Both packages use the `hyperfold` import name;
install only one per environment. The CUDA variant also supports CuPy arrays and
PyTorch CUDA tensors; these frameworks are optional and installed separately.

## Quickstart

```python
import numpy as np
import hyperfold as hf

a = np.array([[4, 1], [1, 3]], dtype=np.float64)
b = np.array([1, 2], dtype=np.float64)

product = hf.matmul(a, a)
solution = hf.solve(a, b)
eigenvalues, eigenvectors = hf.eigh(a)
```

See the [documentation](https://www.braketware.com/hyperfold/index.html) for the
Python API, supported platforms and dtypes, and CUDA usage.
