Skip to content

Commit aeae430

Browse files
authored
[DOCS] Warning in ITensors.compile docs about ITensors v0.7
Add warning in `ITensors.compile()` docstring about requiring `ITensorMPS.jl` to be loaded in ITensors v0.7. Addresses #1605.
1 parent f55dbc4 commit aeae430

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

src/packagecompile/compile.jl

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,5 +50,11 @@ This will take some time, perhaps a few minutes.
5050
This will create a system image containing the compiled version of ITensors
5151
located at `dir/filename`, by default `$(default_compile_path())`.
5252
53+
!!! compat "ITensors 0.7"
54+
As of ITensors 0.7, you must now install and load the
55+
[ITensorMPS.jl](https://github.com/ITensor/ITensorMPS.jl) package
56+
in order to use `ITensors.compile()`, since it relies on running MPS/MPO
57+
functionality as example code for Julia to compile.
58+
5359
$(compile_note())
5460
""" compile

0 commit comments

Comments
 (0)