# ffsim

```{include} ../README.md
:start-after: <!-- start introduction -->
:end-before: <!-- end introduction -->
```

## Installation

```{include} ../README.md
:start-after: <!-- start installation -->
:end-before: <!-- end installation -->
```

## Get started

```{include} ../README.md
:start-after: <!-- start get-started -->
:end-before: <!-- end get-started -->
```

## Multithreading

```{include} ../README.md
:start-after: <!-- start multithreading -->
:end-before: <!-- end multithreading -->
```

## Code example

```{include} ../README.md
:start-after: <!-- start code-example -->
:end-before: <!-- end code-example -->
```

## Citing ffsim

```{include} ../README.md
:start-after: <!-- start citing -->
:end-before: <!-- end citing -->
```

## Contents

```{toctree}
:maxdepth: 2

install
tutorials/index
explanations/index
how-to-guides/index
api/index
GitHub <https://github.com/qiskit-community/ffsim>
Developer guide <https://github.com/qiskit-community/ffsim/blob/main/CONTRIBUTING.md>
Release notes <https://github.com/qiskit-community/ffsim/releases>
Development branch docs <https://qiskit-community.github.io/ffsim/dev/>
```
