Skip to content

Commit e3c7c6a

Browse files
authored
[Docs] More clarifications for ITensors.compile()
1 parent e5eee23 commit e3c7c6a

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

docs/src/AdvancedUsageGuide.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -816,8 +816,17 @@ julia> @time svd(A, i');
816816
ITensors provides the command `ITensors.compile()` to create what is
817817
called a "custom system image", a custom version of Julia that
818818
includes a compiled version of ITensors (see the [PackageCompiler documentation](https://julialang.github.io/PackageCompiler.jl/dev/) for more details).
819-
Just run the command:
819+
820+
!!! compat "ITensors 0.7"
821+
As of ITensors 0.7, you must now install and load the
822+
[ITensorMPS.jl](https://github.com/ITensor/ITensorMPS.jl) package
823+
in order to use `ITensors.compile()`, since it relies on running MPS/MPO
824+
functionality as example code for Julia to compile.
825+
826+
Just run the commands:
820827
```
828+
julia> using ITensors, ITensorMPS
829+
821830
julia> ITensors.compile()
822831
[...]
823832
```

0 commit comments

Comments
 (0)