Skip to content

Commit cf00f07

Browse files
committed
Fix README
1 parent 67c0aaf commit cf00f07

File tree

1 file changed

+2
-23
lines changed

1 file changed

+2
-23
lines changed

README.md

Lines changed: 2 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -22,35 +22,14 @@ Pkg.add("SimpleTensorTrains")
2222

2323
## Quick Start
2424

25-
```julia
26-
using SimpleTensorTrains
27-
using ITensors, ITensorMPS
28-
29-
# Create a SimpleTensorTrain from an MPS
30-
mps = randomMPS(siteinds("S=1/2", 10))
31-
stt = SimpleTensorTrain(mps)
32-
33-
# Perform operations
34-
stt_sum = stt + stt # Addition using direct sum
35-
stt_scaled = 2.0 * stt # Scalar multiplication
36-
37-
# Contract two tensor trains
38-
result = contract(stt, stt; alg=Algorithm"fit"(), maxdim=100)
39-
40-
# Truncate
41-
truncated = truncate(stt; cutoff=1e-10, maxdim=50)
42-
43-
# Get information
44-
bond_dim = maxlinkdim(stt)
45-
sites = siteinds(stt)
46-
```
25+
TODO: Add quick start example.
4726

4827
## Key Design Choices
4928

5029
This library makes specific algorithmic choices to ensure numerical accuracy, especially important for operations with quantics tensor trains:
5130

5231
- **Addition**: Uses `Algorithm"directsum"` for exact representation without approximation
53-
- **Subtraction**: Uses `Algorithm"directsum"` for optimal numerical precision
32+
- **Subtraction**: Uses `Algorithm"directsum"` for exact representation without approximation
5433
- **Contraction**: Offers multiple algorithms (fit, densitymatrix, zipup, naive) with sensible defaults
5534

5635
## Documentation

0 commit comments

Comments
 (0)