Skip to content

Commit

Permalink
doc fixes [skip tests]
Browse files Browse the repository at this point in the history
  • Loading branch information
pablosanjose committed Oct 11, 2023
1 parent 3b4f1c5 commit 831f44d
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 3 deletions.
Binary file added docs/src/assets/star_shape_ldos.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/src/tutorial/greenfunctions.md
Original file line number Diff line number Diff line change
Expand Up @@ -270,7 +270,7 @@ julia> g_1_to_all = sum(abs2, g(0.1)[siteselector(), 1], dims = 2);
julia> qplot(h, hide = :hops, sitecolor = (i, r) -> gω[i], siteradius = (i, r) -> gω[i], minmaxsiteradius = (0, 2), sitecolormap = :balance)
```
```@raw html
<img src="../../assets/star_shape.png" alt="Green function from a contact on the right" width="250" class="center"/>
<img src="../../assets/star_shape.png" alt="Green function from a contact on the right" width="500" class="center"/>
```

!!! warning "Caveat for multiorbital systems"
Expand Down
4 changes: 2 additions & 2 deletions docs/src/tutorial/observables.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ LocalSpectralDensitySolution{Float64} : local density of states at fixed energy
julia> qplot(h, hide = :hops, sitecolor = ρ, siteradius = ρ, minmaxsiteradius = (0, 2), sitecolormap = :balance)
```
```@raw html
<img src="../../assets/star_shape_ldos.png" alt="LDOS" width="250" class="center"/>
<img src="../../assets/star_shape_ldos.png" alt="LDOS" width="500" class="center"/>
```

Note that `ρ[sites...]` produces a vector with the LDOS at sites defined by `siteselector(; sites...)` (`ρ[]` is the ldos over all sites). We can also define a `kernel` to be traced over orbitals to obtain the spectral density of site-local observables (see `diagonal` slicing in the preceding section).
Expand All @@ -47,7 +47,7 @@ CurrentDensitySolution{Float64} : current density at a fixed energy and arbitrar
julia> qplot(h, siteradius = 0.08, sitecolor = :black, siteoutline = 0, hopradius = J, hopcolor = J, minmaxhopradius = (0, 2), hopcolormap = :balance, hopdarken = 0)
```
```@raw html
<img src="../../assets/star_shape_current.png" alt="Current density with magnetic flux" width="250" class="center"/>
<img src="../../assets/star_shape_current.png" alt="Current density with magnetic flux" width="500" class="center"/>
```
!!! note "Remember to construct supercell before applying position-dependent fields"
Note that we built the supercell before applying the model with the magnetic flux. Not doing so would make the gauge field be repeated in each unit cell when expanding the supercell. This was mentioned in the section on Hamiltonians, and is a common mistake when modeling systems with position dependent fields.
Expand Down

0 comments on commit 831f44d

Please sign in to comment.