Skip to content

Commit

Permalink
[DOCS] Warning in ITensors.compile docs about ITensors v0.7
Browse files Browse the repository at this point in the history
Add warning in `ITensors.compile()` docstring about requiring `ITensorMPS.jl` to be loaded in ITensors v0.7. Addresses #1605.
  • Loading branch information
mtfishman authored Dec 13, 2024
1 parent f55dbc4 commit aeae430
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions src/packagecompile/compile.jl
Original file line number Diff line number Diff line change
Expand Up @@ -50,5 +50,11 @@ This will take some time, perhaps a few minutes.
This will create a system image containing the compiled version of ITensors
located at `dir/filename`, by default `$(default_compile_path())`.
!!! 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.
$(compile_note())
""" compile

0 comments on commit aeae430

Please sign in to comment.