Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Hertz4 authored Jul 5, 2024
1 parent 82e983a commit d47f649
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit d47f649

Please sign in to comment.