Skip to content

Commit

Permalink
update tools docs
Browse files Browse the repository at this point in the history
  • Loading branch information
joshuabmoore committed Dec 23, 2024
1 parent 368441b commit 55c02e8
Showing 1 changed file with 17 additions and 2 deletions.
19 changes: 17 additions & 2 deletions docs/src/tools.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,30 @@
# Tools


## Entanglement Entropy
What it is? What it tells us...

### Overview

### Bipartite Entanglement Entropy (BEE)
Given a [`trainedMPS`](@ref), we can compute the bipartite entanglement entropy (BEE) using:
```Julia
bees = bipartite_spectrum(mps);
```
The return value is a vector corresponding to the BEE of each class mps.


### Single-Site Entanglement Entropy (SEE)
Given a [`trainedMPS`](@ref), we can compute the single-site entanglement entropy (SEE) using:
```Julia
sees = MPSTime.single_site_spectrum(mps);
```

## Docstrings
```@docs
MPSTime.von_neumann_entropy
MPSTime.bipartite_spectrum
```

## Internal Methods
```@docs
MPSTime.single_site_spectrum
```

0 comments on commit 55c02e8

Please sign in to comment.