---
jupytext:
  text_representation:
    extension: .md
    format_name: myst
    format_version: 0.13
    jupytext_version: 1.14.4
kernelspec:
  display_name: Python 3 (ipykernel)
  language: python
  name: python3
---

# pymf

```{toctree}
:hidden:
:maxdepth: 1
:caption: Tutorials

mf_notes.md
graphene_example.md
hubbard_1d.md
```

```{toctree}
:hidden:
:maxdepth: 1
:caption: Documentation

mf_notes.md
algorithm.md
documentation/pymf.md
```

## What is pymf?

## Why pymf?

## How does pymf work?

## What does pymf not do yet?

## Installation

```bash
pip install .
```
## Citing

## Contributing