Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mtfishman authored Jun 15, 2024
1 parent f637de9 commit 9321d8c
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,6 @@ c[(2, 3, 4, 5)]
```
This outputs a dictionary mapping the set of sites `i, j, k, l` to the resulting correlator `<Sz_i Sz_j Sz_k Sz_l>`, so in the last line above we are accessing the result for the correlator `<Sz_2 Sz_3 Sz_4 Sz_5>`.

## Known issues

Note that currently, when fermionic sites are being used, this package does not handle the case of mixed `A`- and `C`-operators acting on the same sites properly (i.e. it doesn't handle inputs `(2, 3, 3, 5)` properly for `("Adagdn", "Adagup", "Cup", "Cdn")`, say compared to how that operator would be constructed in the `OpSum` to `MPO` converter in ITensorMPS.jl). This is not very common, and generally users should just use `C`-operators if they want to compute correlators involving fermionic creation and annhilation operators. When `C`-operators are used with fermionic sites the `correlator` function will automatically insert the correct Jordan-Wigner strings to handle fermionic statistics.

0 comments on commit 9321d8c

Please sign in to comment.