[DOCS] Fix ITensors.compile docs

ITensor · Dec 13, 2024 · d8e3658 · d8e3658 · mtfishman · Dec 13, 2024
1 parent 88f7d3e
commit d8e3658
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 8 deletions.
diff --git a/Project.toml b/Project.toml
@@ -1,7 +1,7 @@
 name = "ITensors"
 uuid = "9136182c-28ba-11e9-034c-db9fb085ebd5"
 authors = ["Matthew Fishman <[email protected]>", "Miles Stoudenmire <[email protected]>"]
-version = "0.7.10"
+version = "0.7.11"
 
 [deps]
 Adapt = "79e6a3ab-5dfb-504d-930d-738a2a938a0e"

diff --git a/docs/src/AdvancedUsageGuide.md b/docs/src/AdvancedUsageGuide.md
@@ -818,15 +818,19 @@ 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).
 
 !!! compat "ITensors 0.7"
-    As of ITensors 0.7, you must now install and load the
+    As of ITensors 0.7, you must now install and load both 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.
+    and the [PackageCompiler.jl](https://github.com/JuliaLang/PackageCompiler.jl)
+    package in order to use `ITensors.compile()`, since it relies on running MPS/MPO
+    functionality as example code for Julia to compile and is based in a package
+    extension in order to make `PackageCompiler.jl` an optional dependency.
 
 Just run the commands:
 ```
 julia> using ITensors, ITensorMPS
 
+julia> using PackageCompiler
+
 julia> ITensors.compile()
 [...]
 ```

diff --git a/src/packagecompile/compile.jl b/src/packagecompile/compile.jl
@@ -44,17 +44,19 @@ end
     ITensors.compile(; dir = "$(default_compile_dir())",
                        filename = "$(default_compile_filename())")
 
-Compile ITensors.jl with [PackageCompiler](https://julialang.github.io/PackageCompiler.jl/dev/).
+Compile ITensors.jl with [PackageCompiler.jl](https://julialang.github.io/PackageCompiler.jl/dev/).
 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
+    As of ITensors 0.7, you must now install and load both 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.
+    and the [PackageCompiler.jl](https://github.com/JuliaLang/PackageCompiler.jl)
+    package in order to use `ITensors.compile()`, since it relies on running MPS/MPO
+    functionality as example code for Julia to compile and is based in a package
+    extension in order to make `PackageCompiler.jl` an optional dependency.
 
 $(compile_note())
 """ compile