Skip to content

Commit 7195cd7

Browse files
authored
Add installation instructions and clean up
1 parent d600525 commit 7195cd7

File tree

1 file changed

+11
-4
lines changed

1 file changed

+11
-4
lines changed

README.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,16 @@
33
[![Build status (Github Actions)](https://github.com/JaydevSR/FermionXYModels.jl/workflows/CI/badge.svg)](https://github.com/JaydevSR/FermionXYModels.jl/actions)
44
[![codecov.io](http://codecov.io/github/JaydevSR/FermionXYModels.jl/coverage.svg?branch=main)](http://codecov.io/github/JaydevSR/FermionXYModels.jl?branch=main)
55

6-
**Correlation Matrix of Quantum XY Model by projecting the spins to spinless fermions.**
6+
_**Quantum XY Model by projecting the spins to spinless fermions.**_
77

8-
Reference: Stéphan, J., Misguich, G., & Pasquier, V. (2010). Rényi entropy of a line in two-dimensional Ising models. Physical Review B, 82(12). doi:10.1103/physrevb.82.125455
8+
**Reference**: Stéphan, J., Misguich, G., & Pasquier, V. (2010). Rényi entropy of a line in two-dimensional Ising models. Physical Review B, 82(12). doi:10.1103/physrevb.82.125455
9+
10+
## Installation
11+
12+
```julia
13+
using Pkg
14+
Pkg.add("FermionXYModels.jl")
15+
```
916

1017
## Models
1118

@@ -23,9 +30,9 @@ Reference: Stéphan, J., Misguich, G., & Pasquier, V. (2010). Rényi entropy
2330

2431
- `FermionIsingChain`: The quantum XY model for $\gamma=1$.
2532

26-
## FermionBasis
33+
## Iterators
2734

28-
the `FermionBasis` constructor can be used to construct an iterator over the binary basis of fermion chains. It accepts the following arguments:
35+
- `FermionBasis`: An Iterator over the binary basis of fermion chains. It accepts the following arguments:
2936

3037
**Arguments:**
3138
- `n_sites::Int`: The number of sites in fermion chain.

0 commit comments

Comments
 (0)