Welcome to sparse-ir documentation

This document describes the sparse-ir ecosystem including the following libraries:

• sparse-ir-rs: Rust implementation (crate sparse-ir) with the C API (the C library libsparseir) and Fortran bindings

• sparse-ir: Python library

• SparseIR.jl: Julia library

We describe the basis knowledge of the intermediate representation. The notation and conventions shared by this document and the libraries, with the names of the corresponding objects in each library, are summarized in Notation and conventions.

For the Python and Julia libraries, we provide comprehensive tutorials in the sparse-ir-tutorial tutorial website. For detailed usage of the libraries and their API, please refer to the documentation and test codes of each library.