Examples

Everything related to constructing examples that motivate and teach how to use our package. This includes:

• coming up with new interesting physical systems
• cleaning up the existing ones

and likely more.

docs/source/tutorial/graphene_example.md

@@ -68,11 +68,11 @@ To define the interactions, we need to specify two functions:
 * `nn_int(site1, site2)`: returns the interaction matrix between `site1` and `site2`.
 
 We feed these functions to the {autolink}`~pymf.kwant_helper.utils.build_interacting_syst` function, which constructs the `kwant.Builder` object encoding the interactions.
-All we need to do is to convert this object to a tight-binding dictionary using the {autolink}`~pymf.kwant_helper.utils.builder_to_tb` function
+All we need to do is to convert this object to a tight-binding dictionary using the {autolink}`~pymf.kwant_helper.utils.builder_to_tb` function.
 
 ```{code-cell} ipython3
 def onsite_int(site, U):
-    return U * np.ones((2, 2))
+    return U * sx
 
 def nn_int(site1, site2, V):
     return V * np.ones((2, 2))
@@ -177,7 +177,7 @@ plt.show()
 This phase diagram has gap openings at the same places as shown in the [literature](https://arxiv.org/abs/1204.4531).
 
 We can now use the stored results in `mf_sols` to fully map out the phase diagram with order parameters.
-On top of the charge density wave (CDW), we also expect a spin density wave (SDW) in different regions of the phase diagram.
+On top of the charge density wave (CDW), we also expect a spin density wave (SDW) in a different region of the phase diagram.
 We construct the SDW order parameter with the same steps as before, but now we need to sum over the expectation values of the three Pauli matrices to account for the $SU(2)$ spin-rotation symmetry.
 
 ```{code-cell} ipython3
@@ -206,7 +206,7 @@ We naively do this by plotting the difference between CDW and SDW order paramete
 
 ```{code-cell} ipython3
 import matplotlib.ticker as mticker
-normalized_gap = gap/np.max(gap)
+normalized_gap = gaps/np.max(gaps)
 plt.imshow((cdw_list - sdw_list).T, extent=(Us[0], Us[-1], Vs[0], Vs[-1]), origin='lower', aspect='auto', cmap="coolwarm", alpha=normalized_gap.T, vmin=-2.6, vmax=2.6)
 plt.colorbar(ticks=[-2.6, 0, 2.6], format=mticker.FixedFormatter(['SDW', '0', 'CDW']), label='Order parameter', extend='both')
 plt.xlabel('V')