build based on 63c7d97

Author: Documenter.jl

previews/PR1680/.documenter-siteinfo.json

@@ -1 +1 @@
-{"documenter":{"julia_version":"1.12.1","generation_timestamp":"2025-11-12T17:32:51","documenter_version":"1.15.0"}}
+{"documenter":{"julia_version":"1.12.1","generation_timestamp":"2025-11-13T16:52:13","documenter_version":"1.15.0"}}

previews/PR1680/ContractionSequenceOptimization.html

@@ -36,7 +36,7 @@
 
 $ julia -t 4
 
-$ JULIA_NUM_THREADS=4 julia</code></pre><p>In addition, we have found that it is best to disable <code>BLAS</code> and <code>Strided</code> multithreading when using block sparse multithreading. You can do that with the commands <code>using LinearAlgebra; BLAS.set_num_threads(1)</code> and <code>ITensors.Strided.disable_threads()</code>.</p><p>See also: <code>ITensors.enable_threaded_blocksparse</code>, <code>ITensors.disable_threaded_blocksparse</code>, <code>ITensors.using_threaded_blocksparse</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/ITensor/ITensors.jl/blob/ca0c020dcca2eae3f426e0352bf5135feb8adcc7/src/global_variables.jl#L141-L168">source</a></section><section><div><pre><code class="language-julia hljs">enable_threaded_blocksparse(enable::Bool)</code></pre><p><code>enable_threaded_blocksparse(true)</code> enables threaded block sparse operations (equivalent to <code>enable_threaded_blocksparse()</code>).</p><p><code>enable_threaded_blocksparse(false)</code> disables threaded block sparse operations (equivalent to <code>enable_threaded_blocksparse()</code>).</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/ITensor/ITensors.jl/blob/ca0c020dcca2eae3f426e0352bf5135feb8adcc7/src/global_variables.jl#L146-L154">source</a></section></article><p>Here is a simple example of using block sparse multithreading to speed up a sparse tensor contraction:</p><pre><code class="language-julia hljs">using BenchmarkTools
+$ JULIA_NUM_THREADS=4 julia</code></pre><p>In addition, we have found that it is best to disable <code>BLAS</code> and <code>Strided</code> multithreading when using block sparse multithreading. You can do that with the commands <code>using LinearAlgebra; BLAS.set_num_threads(1)</code> and <code>ITensors.Strided.disable_threads()</code>.</p><p>See also: <code>ITensors.enable_threaded_blocksparse</code>, <code>ITensors.disable_threaded_blocksparse</code>, <code>ITensors.using_threaded_blocksparse</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/ITensor/ITensors.jl/blob/63c7d979f4cec09f24b9ff2d67f6e280e8286084/src/global_variables.jl#L141-L168">source</a></section><section><div><pre><code class="language-julia hljs">enable_threaded_blocksparse(enable::Bool)</code></pre><p><code>enable_threaded_blocksparse(true)</code> enables threaded block sparse operations (equivalent to <code>enable_threaded_blocksparse()</code>).</p><p><code>enable_threaded_blocksparse(false)</code> disables threaded block sparse operations (equivalent to <code>enable_threaded_blocksparse()</code>).</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/ITensor/ITensors.jl/blob/63c7d979f4cec09f24b9ff2d67f6e280e8286084/src/global_variables.jl#L146-L154">source</a></section></article><p>Here is a simple example of using block sparse multithreading to speed up a sparse tensor contraction:</p><pre><code class="language-julia hljs">using BenchmarkTools
 using ITensors
 using LinearAlgebra
 using Strided
@@ -92,4 +92,4 @@
 Threaded contract:
   5.934 ms (446 allocations: 7.37 MiB)
 
-C_contract ≈ C_threaded_contract = true</code></pre><p>In addition, we plan to add more threading to other parts of the code beyond contraction (such as SVD) and improve composibility with other forms of threading like BLAS and Strided, so stay tuned!</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="UpgradeGuide_0.1_to_0.2.html">« Upgrading from 0.1 to 0.2</a><a class="docs-footer-nextpage" href="RunningOnGPUs.html">Running on GPUs »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.15.0 on <span class="colophon-date" title="Wednesday 12 November 2025 17:32">Wednesday 12 November 2025</span>. Using Julia version 1.12.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+C_contract ≈ C_threaded_contract = true</code></pre><p>In addition, we plan to add more threading to other parts of the code beyond contraction (such as SVD) and improve composibility with other forms of threading like BLAS and Strided, so stay tuned!</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="UpgradeGuide_0.1_to_0.2.html">« Upgrading from 0.1 to 0.2</a><a class="docs-footer-nextpage" href="RunningOnGPUs.html">Running on GPUs »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.15.0 on <span class="colophon-date" title="Thursday 13 November 2025 16:52">Thursday 13 November 2025</span>. Using Julia version 1.12.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

previews/PR1680/HDF5FileFormats.html

@@ -185,4 +185,4 @@
  2: QN("Sz",-1) => 1
  (dim=2|id=810|"S=1/2,Site,n=4") <Out>
  1: QN("Sz",1) => 1
- 2: QN(&quot;Sz&quot;,-1) =&gt; 1</code></pre><p>This shouldn&#39;t affect end users in general. The new convention is a bit more intuitive since the quantum number can be thought of as counting the total number of 1 bits in the state, though the conventions can be mapped to each other with a constant.</p><h3 id="maxlinkdim-for-MPS/MPO-with-no-indices"><a class="docs-heading-anchor" href="#maxlinkdim-for-MPS/MPO-with-no-indices"><code>maxlinkdim</code> for MPS/MPO with no indices</a><a id="maxlinkdim-for-MPS/MPO-with-no-indices-1"></a><a class="docs-heading-anchor-permalink" href="#maxlinkdim-for-MPS/MPO-with-no-indices" title="Permalink"></a></h3><p><code>maxlinkdim(::MPS/MPO)</code> returns a minimum of <code>1</code> (previously it returned 0 for MPS/MPO without and link indices) (<a href="https://github.com/ITensor/ITensors.jl/pull/663">PR #663</a>).</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="faq/JuliaPkg.html">« Julia Package Manager FAQs</a><a class="docs-footer-nextpage" href="Multithreading.html">Multithreading »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.15.0 on <span class="colophon-date" title="Wednesday 12 November 2025 17:32">Wednesday 12 November 2025</span>. Using Julia version 1.12.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+ 2: QN(&quot;Sz&quot;,-1) =&gt; 1</code></pre><p>This shouldn&#39;t affect end users in general. The new convention is a bit more intuitive since the quantum number can be thought of as counting the total number of 1 bits in the state, though the conventions can be mapped to each other with a constant.</p><h3 id="maxlinkdim-for-MPS/MPO-with-no-indices"><a class="docs-heading-anchor" href="#maxlinkdim-for-MPS/MPO-with-no-indices"><code>maxlinkdim</code> for MPS/MPO with no indices</a><a id="maxlinkdim-for-MPS/MPO-with-no-indices-1"></a><a class="docs-heading-anchor-permalink" href="#maxlinkdim-for-MPS/MPO-with-no-indices" title="Permalink"></a></h3><p><code>maxlinkdim(::MPS/MPO)</code> returns a minimum of <code>1</code> (previously it returned 0 for MPS/MPO without and link indices) (<a href="https://github.com/ITensor/ITensors.jl/pull/663">PR #663</a>).</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="faq/JuliaPkg.html">« Julia Package Manager FAQs</a><a class="docs-footer-nextpage" href="Multithreading.html">Multithreading »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.15.0 on <span class="colophon-date" title="Thursday 13 November 2025 16:52">Thursday 13 November 2025</span>. Using Julia version 1.12.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>