Skip to content

Commit

Permalink
[Docs] More clarifications for ITensors.compile()
Browse files Browse the repository at this point in the history
  • Loading branch information
mtfishman authored Dec 13, 2024
1 parent e5eee23 commit e3c7c6a
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion docs/src/AdvancedUsageGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -816,8 +816,17 @@ julia> @time svd(A, i');
ITensors provides the command `ITensors.compile()` to create what is
called a "custom system image", a custom version of Julia that
includes a compiled version of ITensors (see the [PackageCompiler documentation](https://julialang.github.io/PackageCompiler.jl/dev/) for more details).
Just run the command:
!!! compat "ITensors 0.7"
As of ITensors 0.7, you must now install and load the
[ITensorMPS.jl](https://github.com/ITensor/ITensorMPS.jl) package
in order to use `ITensors.compile()`, since it relies on running MPS/MPO
functionality as example code for Julia to compile.
Just run the commands:
```
julia> using ITensors, ITensorMPS

julia> ITensors.compile()
[...]
```
Expand Down

0 comments on commit e3c7c6a

Please sign in to comment.