Skip to content

Commit

Permalink
build based on 4bf744b
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Nov 20, 2024
1 parent 828d43a commit 22ac174
Show file tree
Hide file tree
Showing 37 changed files with 3,473 additions and 0 deletions.
1 change: 1 addition & 0 deletions previews/PR255/.documenter-siteinfo.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"documenter":{"julia_version":"1.11.1","generation_timestamp":"2024-11-20T14:18:22","documenter_version":"1.8.0"}}
2 changes: 2 additions & 0 deletions previews/PR255/alternatives.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
<!DOCTYPE html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Alternatives · Tenet.jl</title><meta name="title" content="Alternatives · Tenet.jl"/><meta property="og:title" content="Alternatives · Tenet.jl"/><meta property="twitter:title" content="Alternatives · Tenet.jl"/><meta name="description" content="Documentation for Tenet.jl."/><meta property="og:description" content="Documentation for Tenet.jl."/><meta property="twitter:description" content="Documentation for Tenet.jl."/><script data-outdated-warner src="assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL="."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="assets/documenter.js"></script><script src="search_index.js"></script><script src="siteinfo.js"></script><script src="../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/catppuccin-mocha.css" data-theme-name="catppuccin-mocha"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/catppuccin-macchiato.css" data-theme-name="catppuccin-macchiato"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/catppuccin-frappe.css" data-theme-name="catppuccin-frappe"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/catppuccin-latte.css" data-theme-name="catppuccin-latte"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="assets/themeswap.js"></script><link href="assets/favicon.ico" rel="icon" type="image/x-icon"/><link href="assets/citations.css" rel="stylesheet" type="text/css"/><link href="assets/youtube.css" rel="stylesheet" type="text/css"/></head><body><div id="documenter"><nav class="docs-sidebar"><a class="docs-logo" href="index.html"><img class="docs-light-only" src="assets/logo.svg" alt="Tenet.jl logo"/><img class="docs-dark-only" src="assets/logo-dark.svg" alt="Tenet.jl logo"/></a><div class="docs-package-name"><span class="docs-autofit"><a href="index.html">Tenet.jl</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li><a class="tocitem" href="index.html">Home</a></li><li><a class="tocitem" href="tensors.html">Tensors</a></li><li><a class="tocitem" href="tensor-network.html">Tensor Networks</a></li><li><a class="tocitem" href="contraction.html">Contraction</a></li><li><a class="tocitem" href="transformations.html">Transformations</a></li><li><span class="tocitem">Quantum</span><ul><li><a class="tocitem" href="quantum.html">Introduction</a></li><li><input class="collapse-toggle" id="menuitem-6-2" type="checkbox"/><label class="tocitem" for="menuitem-6-2"><span class="docs-label">Ansatzes</span><i class="docs-chevron"></i></label><ul class="collapsed"><li><a class="tocitem" href="ansatz/product.html"><code>Product</code> ansatz</a></li><li><a class="tocitem" href="ansatz/chain.html"><code>Chain</code> ansatz</a></li></ul></li></ul></li><li><a class="tocitem" href="visualization.html">Visualization</a></li><li class="is-active"><a class="tocitem" href="alternatives.html">Alternatives</a></li><li><a class="tocitem" href="references.html">References</a></li><li><span class="tocitem">⚒️ Developer Reference</span><ul><li><a class="tocitem" href="developer/type-hierarchy.html"><code>TensorNetwork</code> type hierarchy</a></li></ul></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href="alternatives.html">Alternatives</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href="alternatives.html">Alternatives</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/bsc-quantic/Tenet.jl" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/bsc-quantic/Tenet.jl/blob/master/docs/src/alternatives.md" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="Alternatives"><a class="docs-heading-anchor" href="#Alternatives">Alternatives</a><a id="Alternatives-1"></a><a class="docs-heading-anchor-permalink" href="#Alternatives" title="Permalink"></a></h1><p><code>Tenet</code> is strongly opinionated. We acknowledge that it may not suit all cases (although we try 🙂). If your case doesn&#39;t fit <code>Tenet</code>&#39;s design, you can try the following libraries:</p><ul><li><a href="https://github.com/jcmgray/quimb">quimb</a> (<a href="references.html#gray2018quimb">Gray, 2018</a>) Flexible Tensor Network written in Python. Main source of inspiration for <code>Tenet</code>.</li><li><a href="https://github.com/tenpy/tenpy">tenpy</a> (<a href="references.html#hauschild2021tensor">Hauschild <em>et al.</em>, 2021</a>) Tensor Network library written in Python with a strong focus on physics.</li><li><a href="https://github.com/ITensor/ITensors.jl">ITensors.jl</a> (<a href="references.html#itensor">Fishman <em>et al.</em>, 2022</a>) Mature Tensor Network framework written in Julia.</li><li><a href="https://github.com/joserapa98/tensorkrowch">tensorkrowch</a> (<a href="references.html#ramon2023tensorkrowch">Ramón Pareja Monturiol <em>et al.</em>, 2023</a>) A new Tensor Network library built on top of PyTorch.</li></ul></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="visualization.html">« Visualization</a><a class="docs-footer-nextpage" href="references.html">References »</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.8.0 on <span class="colophon-date" title="Wednesday 20 November 2024 14:18">Wednesday 20 November 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
24 changes: 24 additions & 0 deletions previews/PR255/ansatz/chain.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
<!DOCTYPE html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Chain ansatz · Tenet.jl</title><meta name="title" content="Chain ansatz · Tenet.jl"/><meta property="og:title" content="Chain ansatz · Tenet.jl"/><meta property="twitter:title" content="Chain ansatz · Tenet.jl"/><meta name="description" content="Documentation for Tenet.jl."/><meta property="og:description" content="Documentation for Tenet.jl."/><meta property="twitter:description" content="Documentation for Tenet.jl."/><script data-outdated-warner src="../assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL=".."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../assets/documenter.js"></script><script src="../search_index.js"></script><script src="../siteinfo.js"></script><script src="../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-mocha.css" data-theme-name="catppuccin-mocha"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-macchiato.css" data-theme-name="catppuccin-macchiato"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-frappe.css" data-theme-name="catppuccin-frappe"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-latte.css" data-theme-name="catppuccin-latte"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../assets/themeswap.js"></script><link href="../assets/favicon.ico" rel="icon" type="image/x-icon"/><link href="../assets/citations.css" rel="stylesheet" type="text/css"/><link href="../assets/youtube.css" rel="stylesheet" type="text/css"/></head><body><div id="documenter"><nav class="docs-sidebar"><a class="docs-logo" href="../index.html"><img class="docs-light-only" src="../assets/logo.svg" alt="Tenet.jl logo"/><img class="docs-dark-only" src="../assets/logo-dark.svg" alt="Tenet.jl logo"/></a><div class="docs-package-name"><span class="docs-autofit"><a href="../index.html">Tenet.jl</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li><a class="tocitem" href="../index.html">Home</a></li><li><a class="tocitem" href="../tensors.html">Tensors</a></li><li><a class="tocitem" href="../tensor-network.html">Tensor Networks</a></li><li><a class="tocitem" href="../contraction.html">Contraction</a></li><li><a class="tocitem" href="../transformations.html">Transformations</a></li><li><span class="tocitem">Quantum</span><ul><li><a class="tocitem" href="../quantum.html">Introduction</a></li><li><input class="collapse-toggle" id="menuitem-6-2" type="checkbox" checked/><label class="tocitem" for="menuitem-6-2"><span class="docs-label">Ansatzes</span><i class="docs-chevron"></i></label><ul class="collapsed"><li><a class="tocitem" href="product.html"><code>Product</code> ansatz</a></li><li class="is-active"><a class="tocitem" href="chain.html"><code>Chain</code> ansatz</a><ul class="internal"><li><a class="tocitem" href="#Matrix-Product-Operators-(MPO)"><span>Matrix Product Operators (MPO)</span></a></li></ul></li></ul></li></ul></li><li><a class="tocitem" href="../visualization.html">Visualization</a></li><li><a class="tocitem" href="../alternatives.html">Alternatives</a></li><li><a class="tocitem" href="../references.html">References</a></li><li><span class="tocitem">⚒️ Developer Reference</span><ul><li><a class="tocitem" href="../developer/type-hierarchy.html"><code>TensorNetwork</code> type hierarchy</a></li></ul></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li><a class="is-disabled">Quantum</a></li><li><a class="is-disabled">Ansatzes</a></li><li class="is-active"><a href="chain.html"><code>Chain</code> ansatz</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href="chain.html"><code>Chain</code> ansatz</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/bsc-quantic/Tenet.jl" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/bsc-quantic/Tenet.jl/blob/master/docs/src/ansatz/chain.md" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="Matrix-Product-States-(MPS)"><a class="docs-heading-anchor" href="#Matrix-Product-States-(MPS)">Matrix Product States (MPS)</a><a id="Matrix-Product-States-(MPS)-1"></a><a class="docs-heading-anchor-permalink" href="#Matrix-Product-States-(MPS)" title="Permalink"></a></h1><p>Matrix Product States (MPS) are a Quantum Tensor Network ansatz whose tensors are laid out in a 1D chain. Due to this, these networks are also known as <em>Tensor Trains</em> in other mathematical fields. Depending on the boundary conditions, the chains can be open or closed (i.e. periodic boundary conditions).</p><pre><code class="language- hljs">fig = Figure() # hide

tn_open = rand(MatrixProduct{State,Open}, n=10, χ=4) # hide
tn_periodic = rand(MatrixProduct{State,Periodic}, n=10, χ=4) # hide

plot!(fig[1,1], tn_open, layout=Spring(iterations=1000, C=0.5, seed=100)) # hide
plot!(fig[1,2], tn_periodic, layout=Spring(iterations=1000, C=0.5, seed=100)) # hide

Label(fig[1,1, Bottom()], &quot;Open&quot;) # hide
Label(fig[1,2, Bottom()], &quot;Periodic&quot;) # hide

fig # hide</code></pre><h2 id="Matrix-Product-Operators-(MPO)"><a class="docs-heading-anchor" href="#Matrix-Product-Operators-(MPO)">Matrix Product Operators (MPO)</a><a id="Matrix-Product-Operators-(MPO)-1"></a><a class="docs-heading-anchor-permalink" href="#Matrix-Product-Operators-(MPO)" title="Permalink"></a></h2><p>Matrix Product Operators (MPO) are the operator version of <a href="chain.html#matrix-product-states-mps">Matrix Product State (MPS)</a>. The major difference between them is that MPOs have 2 indices per site (1 input and 1 output) while MPSs only have 1 index per site (i.e. an output).</p><pre><code class="language- hljs">fig = Figure() # hide

tn_open = rand(MatrixProduct{Operator,Open}, n=10, χ=4) # hide
tn_periodic = rand(MatrixProduct{Operator,Periodic}, n=10, χ=4) # hide

plot!(fig[1,1], tn_open, layout=Spring(iterations=1000, C=0.5, seed=100)) # hide
plot!(fig[1,2], tn_periodic, layout=Spring(iterations=1000, C=0.5, seed=100)) # hide

Label(fig[1,1, Bottom()], &quot;Open&quot;) # hide
Label(fig[1,2, Bottom()], &quot;Periodic&quot;) # hide

fig # hide</code></pre><p>In <code>Tenet</code>, the generic <code>MatrixProduct</code> ansatz implements this topology. Type variables are used to address their functionality (<code>State</code> or <code>Operator</code>) and their boundary conditions (<code>Open</code> or <code>Periodic</code>).</p><div class="admonition is-warning"><header class="admonition-header">Missing docstring.</header><div class="admonition-body"><p>Missing docstring for <code>MatrixProduct</code>. Check Documenter&#39;s build log for details.</p></div></div><div class="admonition is-warning"><header class="admonition-header">Missing docstring.</header><div class="admonition-body"><p>Missing docstring for <code>MatrixProduct(::Any)</code>. Check Documenter&#39;s build log for details.</p></div></div></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="product.html">« <code>Product</code> ansatz</a><a class="docs-footer-nextpage" href="../visualization.html">Visualization »</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.8.0 on <span class="colophon-date" title="Wednesday 20 November 2024 14:18">Wednesday 20 November 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit 22ac174

Please sign in to comment.