From d47f649049d8f1946c83f4394a5bcce1ec872635 Mon Sep 17 00:00:00 2001 From: Hertz4 <88074238+Hertz4@users.noreply.github.com> Date: Fri, 5 Jul 2024 13:18:03 +0200 Subject: [PATCH] Update README.md --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index 1258e6a..8837246 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,9 @@ To install `adapol`, run pip install adapol ``` +# Documentation + +See the detailed [documentation](https://flatironinstitute.github.io/adapol/) for physical background, algorithms and user manual. # Examples In the `examples` directory, we provide two examples [`discrete.ipynb`](https://github.com/Hertz4/adapol/blob/main/example/discrete.ipynb) and [`semicircle.ipynb`](https://github.com/Hertz4/adapol/blob/main/example/semicircle.ipynb), showcasing how to use `adapol` for both discrete spectrum and continuous spectrum.