From d491df04fd6e41eb0f0a867eeb6bbff064b6efb7 Mon Sep 17 00:00:00 2001 From: mtfishman Date: Tue, 21 Apr 2026 13:43:41 -0400 Subject: [PATCH 1/2] Inline example output in README MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Follow-up to #23: the README example runs DMRG but doesn't show the resulting output. Add an inlined expected-output block (via Literate `#= ```…``` =#`) so readers can see what the code produces without running it locally. Output values taken from the legacy README.md that existed before the template migration. Regenerate README.md via itpkgfmt so it picks up the change. Co-Authored-By: Claude Opus 4.7 (1M context) --- README.md | 30 ++++++++++++++++++++++++++++++ examples/README.jl | 32 ++++++++++++++++++++++++++++++++ 2 files changed, 62 insertions(+) diff --git a/README.md b/README.md index e27fbf6..9a7c120 100644 --- a/README.md +++ b/README.md @@ -104,6 +104,36 @@ println("\nRun dmrg with free fermion starting state") dmrg(H, ψ0; nsweeps = 4, maxdim = 60, cutoff = 1.0e-12) ```` +This will output something like: +``` +(N, Nf) = (20, 10) +U = 1.0 + +Free fermion starting energy +inner(ψ0', H, ψ0) = -2.3812770621299357 + +Random state starting energy +inner(ψr', H, ψr) = 10.0 + +Run dmrg with random starting state +After sweep 1 energy=6.261701784151 maxlinkdim=2 time=0.041 +After sweep 2 energy=2.844954346204 maxlinkdim=5 time=0.056 +After sweep 3 energy=0.245282430911 maxlinkdim=14 time=0.071 +After sweep 4 energy=-1.439072132586 maxlinkdim=32 time=0.098 +After sweep 5 energy=-2.220202191945 maxlinkdim=59 time=0.148 +After sweep 6 energy=-2.376787647893 maxlinkdim=60 time=0.186 +After sweep 7 energy=-2.381484153892 maxlinkdim=60 time=0.167 +After sweep 8 energy=-2.381489999291 maxlinkdim=57 time=0.233 +After sweep 9 energy=-2.381489999595 maxlinkdim=49 time=0.175 +After sweep 10 energy=-2.381489999595 maxlinkdim=49 time=0.172 + +Run dmrg with free fermion starting state +After sweep 1 energy=-2.381489929965 maxlinkdim=49 time=0.139 +After sweep 2 energy=-2.381489999588 maxlinkdim=49 time=0.165 +After sweep 3 energy=-2.381489999594 maxlinkdim=48 time=0.161 +After sweep 4 energy=-2.381489999594 maxlinkdim=48 time=0.169 +``` + --- *This page was generated using [Literate.jl](https://github.com/fredrikekre/Literate.jl).* diff --git a/examples/README.jl b/examples/README.jl index ddd4990..918d72d 100644 --- a/examples/README.jl +++ b/examples/README.jl @@ -103,3 +103,35 @@ dmrg(H, ψr; nsweeps = 10, maxdim = [10, 20, 40, 60], cutoff = 1.0e-12) println("\nRun dmrg with free fermion starting state") dmrg(H, ψ0; nsweeps = 4, maxdim = 60, cutoff = 1.0e-12) + +# This will output something like: +#= +``` +(N, Nf) = (20, 10) +U = 1.0 + +Free fermion starting energy +inner(ψ0', H, ψ0) = -2.3812770621299357 + +Random state starting energy +inner(ψr', H, ψr) = 10.0 + +Run dmrg with random starting state +After sweep 1 energy=6.261701784151 maxlinkdim=2 time=0.041 +After sweep 2 energy=2.844954346204 maxlinkdim=5 time=0.056 +After sweep 3 energy=0.245282430911 maxlinkdim=14 time=0.071 +After sweep 4 energy=-1.439072132586 maxlinkdim=32 time=0.098 +After sweep 5 energy=-2.220202191945 maxlinkdim=59 time=0.148 +After sweep 6 energy=-2.376787647893 maxlinkdim=60 time=0.186 +After sweep 7 energy=-2.381484153892 maxlinkdim=60 time=0.167 +After sweep 8 energy=-2.381489999291 maxlinkdim=57 time=0.233 +After sweep 9 energy=-2.381489999595 maxlinkdim=49 time=0.175 +After sweep 10 energy=-2.381489999595 maxlinkdim=49 time=0.172 + +Run dmrg with free fermion starting state +After sweep 1 energy=-2.381489929965 maxlinkdim=49 time=0.139 +After sweep 2 energy=-2.381489999588 maxlinkdim=49 time=0.165 +After sweep 3 energy=-2.381489999594 maxlinkdim=48 time=0.161 +After sweep 4 energy=-2.381489999594 maxlinkdim=48 time=0.169 +``` +=# From 92726013512234d0163e526cc1809f57f699528b Mon Sep 17 00:00:00 2001 From: mtfishman Date: Tue, 21 Apr 2026 13:52:39 -0400 Subject: [PATCH 2/2] Bump patch version to 0.1.15 README / examples/README.jl changes are user-visible (downstream readers see the example output block), so this is a substantive change that warrants a patch bump. Co-Authored-By: Claude Opus 4.7 (1M context) --- Project.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Project.toml b/Project.toml index 03941e0..d8ecaac 100644 --- a/Project.toml +++ b/Project.toml @@ -1,6 +1,6 @@ name = "ITensorGaussianMPS" uuid = "2be41995-7c9f-4653-b682-bfa4e7cebb93" -version = "0.1.14" +version = "0.1.15" authors = ["Matthew Fishman and contributors"] [workspace]