Skip to content

[DOCS] More clarifications for ITensors.compile() #1607

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Dec 13, 2024
Merged

[DOCS] More clarifications for ITensors.compile() #1607

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e3c7c6a
[Docs] More clarifications for `ITensors.compile()`
mtfishman Dec 13, 2024
39786fe
[ITensors] Bump to v0.7.10
mtfishman Dec 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Project.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name = "ITensors"
uuid = "9136182c-28ba-11e9-034c-db9fb085ebd5"
authors = ["Matthew Fishman <mfishman@flatironinstitute.org>", "Miles Stoudenmire <mstoudenmire@flatironinstitute.org>"]
version = "0.7.9"
version = "0.7.10"

[deps]
Adapt = "79e6a3ab-5dfb-504d-930d-738a2a938a0e"
Expand Down
11 changes: 10 additions & 1 deletion docs/src/AdvancedUsageGuide.md
View file
Open in desktop
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
Loading