[ITensors] Introduce ITensorsPackageCompilerExt (#1403)

Author: mtfishman

ITensorGaussianMPS/Project.toml

@@ -1,7 +1,7 @@
 name = "ITensorGaussianMPS"
 uuid = "2be41995-7c9f-4653-b682-bfa4e7cebb93"
 authors = ["Matthew Fishman <[email protected]> and contributors"]
-version = "0.1.5"
+version = "0.1.6"
 
 [deps]
 Compat = "34da2185-b29b-5c13-b0c7-acf172513d20"
@@ -10,6 +10,6 @@ LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
 
 [compat]
 Compat = "3.40.0, 4"
-ITensors = "0.3.58, 0.4"
+ITensors = "0.3.58, 0.4, 0.5"
 LinearAlgebra = "1.6"
 julia = "1.6"

ITensorVisualizationBase/Project.toml

@@ -1,7 +1,7 @@
 name = "ITensorVisualizationBase"
 uuid = "cd2553d2-8bef-4d93-8a38-c62f17d5ad23"
 authors = ["Matthew Fishman <[email protected]> and contributors"]
-version = "0.1.6"
+version = "0.1.7"
 
 [deps]
 AbstractTrees = "1520ce14-60c1-5f80-bbc7-55ef81b5835c"
@@ -20,7 +20,7 @@ AbstractTrees = "0.4"
 Compat = "3.40.0, 4"
 GeometryBasics = "0.4.1"
 Graphs = "1.4.1"
-ITensors = "0.2.12, 0.3, 0.4"
+ITensors = "0.2.12, 0.3, 0.4, 0.5"
 MetaGraphs = "0.7.1"
 NetworkLayout = "0.4.3"
 Statistics = "1"

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.4.1"
+version = "0.5.0"
 
 [deps]
 Adapt = "79e6a3ab-5dfb-504d-930d-738a2a938a0e"
@@ -16,7 +16,6 @@ KrylovKit = "0b1a1467-8014-51b9-945f-bf0ae24f4b77"
 LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
 LinearMaps = "7a12625a-238d-50fd-b39a-03d52299707e"
 NDTensors = "23ae76d9-e61a-49c4-8f12-3f1a16adf9cf"
-PackageCompiler = "9b87118b-4619-50d2-8e1e-99f35a4d4d9d"
 PackageExtensionCompat = "65ce6f38-6b18-4e1d-a461-8949797d7930"
 Pkg = "44cfe95a-1eb2-52ea-b672-e2afdf69b78f"
 Printf = "de0858da-6303-5e67-8744-51eddeeeb8d7"
@@ -35,11 +34,13 @@ ZygoteRules = "700de1a5-db45-46bc-99cf-38207098b444"
 [weakdeps]
 HDF5 = "f67ccb44-e63f-5c2f-98bd-6dc0ccc4ba2f"
 Observers = "338f10d5-c7f1-4033-a7d1-f9dec39bcaa0"
+PackageCompiler = "9b87118b-4619-50d2-8e1e-99f35a4d4d9d"
 VectorInterface = "409d34a3-91d5-4945-b6ec-7529ddf182d8"
 
 [extensions]
 ITensorsHDF5Ext = "HDF5"
 ITensorsObserversExt = "Observers"
+ITensorsPackageCompilerExt = "PackageCompiler"
 ITensorsVectorInterfaceExt = "VectorInterface"
 
 [compat]
@@ -56,7 +57,7 @@ KrylovKit = "0.4.2, 0.5, 0.6, 0.7"
 LinearAlgebra = "1.6"
 LinearMaps = "3"
 NDTensors = "0.3.0"
-PackageCompiler = "1.0.0, 2"
+PackageCompiler = "1, 2"
 PackageExtensionCompat = "1"
 Pkg = "1.6"
 Printf = "1.6"
@@ -77,4 +78,5 @@ julia = "1.6"
 [extras]
 HDF5 = "f67ccb44-e63f-5c2f-98bd-6dc0ccc4ba2f"
 Observers = "338f10d5-c7f1-4033-a7d1-f9dec39bcaa0"
+PackageCompiler = "9b87118b-4619-50d2-8e1e-99f35a4d4d9d"
 VectorInterface = "409d34a3-91d5-4945-b6ec-7529ddf182d8"

docs/src/index.md

@@ -29,7 +29,9 @@ Development of ITensor is supported by the Flatiron Institute, a division of the
 
 ## News
 
-- April 16, 2024: ITensors.jl v0.4 has been released. This version removes HDF5 as a dependency (a breaking change) and moves the HDF5 read and write functions for ITensor, MPS, MPO, and other associated types into a package extension. To enable ITensor HDF5 features, install the HDF5 package and put `using HDF5` together with `using ITensors` in your code. Other recent changes include support for multiple GPU backends using package extensions.
+- May 2, 2024: ITensors.jl v0.5 has been released. This version removes PackageCompiler.jl as a dependency and moves the package compilation functionality into a package extension. In order to use the `ITensors.compile()` function going forward, you need to install the PackageCompiler.jl package with `using Pkg: Pkg; Pkg.add("PackageCompiler")` and put `using PackageCompiler` together with `using ITensors` in your code.
+
+- April 16, 2024: ITensors.jl v0.4 has been released. This version removes HDF5.jl as a dependency and moves the HDF5 read and write functions for ITensor, MPS, MPO, and other associated types into a package extension. To enable ITensor HDF5 features, install the HDF5.jl package with `using Pkg: Pkg; Pkg.add("HDF5")` and put `using HDF5` together with `using ITensors` in your code. Other recent changes include support for multiple GPU backends using package extensions.
 
 - March 25, 2022: ITensors.jl v0.3 has been released. The main breaking change is that we no longer support versions of Julia below 1.6. Julia 1.6 is the long term support version of Julia (LTS), which means that going forward versions below Julia 1.6 won't be as well supported with bug fixes and improvements. Additionally, Julia 1.6 introduced many improvements including syntax improvements that we would like to start using with ITensors.jl, which becomes challenging if we try to support Julia versions below 1.6. See [here](https://www.oxinabox.net/2021/02/13/Julia-1.6-what-has-changed-since-1.0.html) and [here](https://julialang.org/blog/2021/03/julia-1.6-highlights/) for some nice summaries of the Julia 1.6 release.
 

ext/ITensorsPackageCompilerExt/ITensorsPackageCompilerExt.jl

@@ -0,0 +1,4 @@
+module ITensorsPackageCompilerExt
+include("compile.jl")
+include("precompile_itensors.jl")
+end

ext/ITensorsPackageCompilerExt/compile.jl

@@ -0,0 +1,26 @@
+using NDTensors: @Algorithm_str
+using ITensors: ITensors
+using PackageCompiler: PackageCompiler
+
+function ITensors.compile(
+  ::Algorithm"PackageCompiler";
+  dir::AbstractString=ITensors.default_compile_dir(),
+  filename::AbstractString=ITensors.default_compile_filename(),
+)
+  if !isdir(dir)
+    println("""The directory "$dir" doesn't exist yet, creating it now.""")
+    println()
+    mkdir(dir)
+  end
+  path = joinpath(dir, filename)
+  println(
+    """Creating the system image "$path" containing the compiled version of ITensors. This may take a few minutes.""",
+  )
+  PackageCompiler.create_sysimage(
+    :ITensors;
+    sysimage_path=path,
+    precompile_execution_file=joinpath(@__DIR__, "precompile_itensors.jl"),
+  )
+  println(ITensors.compile_note(; dir, filename))
+  return path
+end

ext/ITensorsPackageCompilerExt/precompile_itensors.jl

@@ -0,0 +1,28 @@
+using ITensors.ITensorMPS: MPO, OpSum, dmrg, randomMPS, siteinds
+
+# TODO: This uses all of the tests to make
+# precompile statements, but takes a long time
+# (e.g. 700 seconds).
+# Try again with later versions of PackageCompiler
+#
+# include(joinpath(joinpath(dirname(dirname(@__DIR__)),
+#                           test"),
+#                  "runtests.jl"))
+
+function main(; N, dmrg_kwargs)
+  opsum = OpSum()
+  for j in 1:(N - 1)
+    opsum += 0.5, "S+", j, "S-", j + 1
+    opsum += 0.5, "S-", j, "S+", j + 1
+    opsum += "Sz", j, "Sz", j + 1
+  end
+  for conserve_qns in (false, true)
+    sites = siteinds("S=1", N; conserve_qns)
+    H = MPO(opsum, sites)
+    ψ0 = randomMPS(sites, j -> isodd(j) ? "↑" : "↓"; linkdims=2)
+    dmrg(H, ψ0; outputlevel=0, dmrg_kwargs...)
+  end
+  return nothing
+end
+
+main(; N=6, dmrg_kwargs=(; nsweeps=3, maxdim=10, cutoff=1e-13))

src/packagecompile/compile.jl

@@ -1,4 +1,3 @@
-
 default_compile_dir() = joinpath(homedir(), ".julia", "sysimages")
 
 default_compile_filename() = "sys_itensors.so"
@@ -37,26 +36,14 @@ function compile_note(; dir=default_compile_dir(), filename=default_compile_file
   """
 end
 
-function compile(;
-  dir::AbstractString=default_compile_dir(),
-  filename::AbstractString=default_compile_filename(),
-)
-  if !isdir(dir)
-    println("""The directory "$dir" doesn't exist yet, creating it now.""")
-    println()
-    mkdir(dir)
-  end
-  path = joinpath(dir, filename)
-  println(
-    """Creating the system image "$path" containing the compiled version of ITensors. This may take a few minutes.""",
-  )
-  create_sysimage(
-    :ITensors;
-    sysimage_path=path,
-    precompile_execution_file=joinpath(@__DIR__, "precompile_itensors.jl"),
+function compile(; backend=Algorithm"PackageCompiler"(), kwargs...)
+  return compile(backend; kwargs...)
+end
+
+function compile(::Algorithm; kwargs...)
+  return error(
+    "As of ITensors v0.5, you must install `PackageCompiler.jl` (`using Pkg: Pkg; Pkg.add(\"PackageCompiler\")`) and execute `using PackageCompiler` to use `ITensors.compile`.",
   )
-  println(compile_note(; dir=dir, filename=filename))
-  return path
 end
 
 @doc """

src/packagecompile/precompile_itensors.jl

@@ -14,7 +14,6 @@ using IsApprox
 using LinearAlgebra
 using NDTensors
 using NDTensors.RankFactorization: Spectrum, eigs, entropy, truncerror
-using PackageCompiler
 using Pkg
 using Printf
 using Random