Merge pull request #29 from thenoursehorse/unstable

fix: broken links, doc: typos
thenoursehorse · Oct 9, 2023 · 3f0a82d · 3f0a82d
2 parents b5b9a89 + d48fa89
commit 3f0a82d
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 13 deletions.
diff --git a/README.md b/README.md
@@ -17,11 +17,11 @@ fraction of the time, with hopefully not a fraction of the accuracy.
 
 If you want to learn how to solve some common strongly correlated lattice 
 models, and how RISB is implemented, then start with the 
-[tutorials](https://github.com/thenoursehorse/risb/tutorials). 
+[tutorials](https://thenoursehorse.github.io/risb/tutorials). 
 
 If you want to quickly see a calculation, then start with the `examples/` 
 folder in this repository and refer to the 
-[how-to guides](https://github.com/thenoursehorse/risb/how-to/).
+[how-to guides](https://thenoursehorse.github.io/risb/how-to/).
 
 <!-- INDEX-END -->
 

diff --git a/docs/index.md b/docs/index.md
@@ -18,7 +18,7 @@ explanations/index
 ```
 
 ```{toctree}
-:caption: Reference
+:caption: API Docs
 :hidden:
  
 api/risb

diff --git a/docs/tutorials/hubbard.md b/docs/tutorials/hubbard.md
@@ -3,7 +3,7 @@
 In this tutorial you will use `LatticeSolver` and `EmbeddingAtomDiag` to solve 
 the half-filled Hubbard model. This is one of the simplest strongly correlated 
 electron models, yet in general does not have an exact solution. Using this 
-model, you will learn about the Brinkman-Rice [^^Brinkman1970] description of 
+model, you will learn about the Brinkman-Rice [^Brinkman1970] description of 
 a Mott insulator, the quintessential strongly correlated phase of matter. 
 At the end of this tutorial you will have an idea of some of the kinds 
 ground states {{RISB}} can capture, and importantly some of its limitations.
@@ -388,7 +388,7 @@ ground state of the Hubbard model on the cubic lattice at half-filling?
 *Application of Gutzwiller's Variational Method to the Metal-Insulator Transition*,
 Phys. Rev. B **2**, 4302 (1970)](https://doi.org/10.1103/PhysRevB.2.4302).
 
-[^GHOST]: See [N. Lanatà, T.-H. Lee, Y.-X. Yao, and V. Dobrosavljević, 
+[^GHOST]: [N. Lanatà, T.-H. Lee, Y.-X. Yao, and V. Dobrosavljević, 
 *Emergent Bloch excitations in Mott matter*, 
 Phys. Rev. B **96**, 195126 (2017)](https://doi.org/10.1103/PhysRevB.96.195126), 
 and the papers that cite this paper for extensions that improve upon 

diff --git a/docs/tutorials/kagome.md b/docs/tutorials/kagome.md
@@ -1,8 +1,7 @@
-# Hubbard model on kagome lattice
+# Multiple clusters on the kagome lattice
 
 :::{admonition} TODO
-Single-site case. Three-site cluster case. Exercises like, what happens 
-to hybridization? The total spin? The energy? 
+Single-site case. Three-site cluster case.
 :::
 
 In this tutorial you will use :py:class:`LatticeSolver` to solve the 
@@ -11,14 +10,12 @@ ways.
 
 First, as three inequivalent correlated subspaces $\mathcal{C}$ for 
 $i \in \{A, B, C\}$. This will ignore spatial correlations within a triangle 
-in a unit cell. Doing it this way will be faster, and will introduce 
-how the projectors are used.
+in a unit cell. Doing it this way requires constructing projectors onto 
+the different correlated subspaces.
 
 The second way is take a single three-site cluster and 
 have one correlated subspace $\mathcal{C}$. This will include spatial 
-correlations within a triangle in a unit cell. This will be slower, but we 
-will also introduce how local symmetries can be encoded to ensure 
-the system adheres to the symmetries of the system.
+correlations within a triangle in a unit cell.
 
 :::{tip}
 In `examples/kagome_hubbard.py` we provide an example if you are stuck. But