Skip to content

Commit

Permalink
Add sections in Method docs
Browse files Browse the repository at this point in the history
  • Loading branch information
BrieucLD committed May 30, 2024
1 parent 6d65379 commit b0c54b1
Show file tree
Hide file tree
Showing 2 changed files with 44 additions and 1 deletion.
43 changes: 43 additions & 0 deletions docs/src/methods.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,48 @@
# List of all methods

## Matrix Product State (MPS)

```@autodocs
Modules = [MPSDynamics]
Pages = ["mpsBasics.jl", "reshape.jl","tensorOps.jl", "fundamentals.jl", "switchmpo"]
```
## Tree Tensor Network (TTN)

```@autodocs
Modules = [MPSDynamics]
Pages = ["treeBasics.jl", "treeTDVP.jl","treeMeasure.jl", "treeIterators.jl", "treeTDVP.jl"]
```

## Measure and Obervables

```@autodocs
Modules = [MPSDynamics]
Pages = ["measure.jl", "observables.jl"]
```

## Models and Hamiltonians (MPO)

```@autodocs
Modules = [MPSDynamics]
Pages = ["models.jl", "electronkmpo.jl", "excitonphononmpo.jl"]
```

## Chain-Mapping

```@autodocs
Modules = [MPSDynamics]
Pages = ["finitetemperature.jl", "chainOhmT.jl", "gauss.jl", "lanczos.jl", "mcdis2.jl" , "ohmicSpec.jl" , "quadohmT.jl", "r_jacobi.jl", "stieltjes.jl", ]
```

## Dynamics propagation function

```@autodocs
Modules = [MPSDynamics]
Pages = ["MPSDynamics.jl", "chain2TDVP.jl", "chainA1TDVP.jl","chainDMRG.jl","chainTDVP.jl", "run_1TDVP.jl", "run_1TDVPLC.jl", "run_2TDVP.jl", "run_all.jl","run_DTDVP.jl"]
```

## Advanced
```@autodocs
Modules = [MPSDynamics]
Pages = ["flattendict.jl", "logging.jl", "logiter.jl","machines.jl"]
```
2 changes: 1 addition & 1 deletion src/machines.jl
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ end
function init_machines(machs::Vector{T}) where T <: Machine
launch_workers(machs) do pid
@everywhere pid eval(using Pkg)
@everywhere pid Pkg.add(PackageSpec(url="https://github.com/angusdunnett/MPSDynamics.git", rev="master"))
@everywhere pid Pkg.add(PackageSpec(url="https://github.com/shareloqs/MPSDynamics.git", rev="master"))
end
end

Expand Down

0 comments on commit b0c54b1

Please sign in to comment.