# Welcome to symmray's documentation!

[![Tests](https://github.com/jcmgray/symmray/actions/workflows/tests.yml/badge.svg)](https://github.com/jcmgray/symmray/actions/workflows/tests.yml)
[![Code Coverage](https://codecov.io/gh/jcmgray/symmray/branch/main/graph/badge.svg)](https://codecov.io/gh/jcmgray/symmray)
[![Docs](https://readthedocs.org/projects/symmray/badge/?version=latest)](https://symmray.readthedocs.io)
[![PyPI](https://img.shields.io/pypi/v/symmray?color=teal)](https://pypi.org/project/symmray/)
[![Anaconda-Server Badge](https://anaconda.org/conda-forge/symmray/badges/version.svg)](https://anaconda.org/conda-forge/symmray)
[![Pixi Badge](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/prefix-dev/pixi/main/assets/badge/v0.json)](https://pixi.sh)

[`symmray`](symmray) is a minimal library for block sparse, abelian symmetric
and fermionic arrays, designed to look as much as possible like standard
ndarrays, whose blocks can be backed by `numpy`, `torch` or any other
[`autoray`](https://github.com/jcmgray/autoray) compatible library.


```{toctree}
:caption: Guides
:maxdepth: 2

installation.md
```

```{toctree}
:caption: Links
:hidden:

GitHub Repository <https://github.com/jcmgray/symmray>
```