/
index.html
2 lines (2 loc) · 9.94 KB
/
index.html
1
2
<!DOCTYPE html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Home · Documentation | Yao</title><meta name="title" content="Home · Documentation | Yao"/><meta property="og:title" content="Home · Documentation | Yao"/><meta property="twitter:title" content="Home · Documentation | Yao"/><meta name="description" content="Documentation for Documentation | Yao."/><meta property="og:description" content="Documentation for Documentation | Yao."/><meta property="twitter:description" content="Documentation for Documentation | Yao."/><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/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/indigo.css" rel="stylesheet" type="text/css"/><link href="https://yaoquantum.org/assets/favicon-light.ico" rel="icon" type="image/x-icon"/></head><body><div id="documenter"><nav class="docs-sidebar"><a class="docs-logo" href="index.html"><img src="assets/logo.png" alt="Documentation | Yao logo"/></a><div class="docs-package-name"><span class="docs-autofit"><a href="index.html">Documentation | Yao</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 class="is-active"><a class="tocitem" href="index.html">Home</a><ul class="internal"><li><a class="tocitem" href="#Quick-Starts"><span>Quick Starts</span></a></li><li><a class="tocitem" href="#Pluto-Notebooks"><span>Pluto Notebooks</span></a></li><li><a class="tocitem" href="#Manual"><span>Manual</span></a></li></ul></li><li><a class="tocitem" href="quick-start.html">Quick Start</a></li><li><span class="tocitem">Manual</span><ul><li><a class="tocitem" href="man/registers.html">Quantum Registers</a></li><li><a class="tocitem" href="man/blocks.html">Blocks</a></li><li><a class="tocitem" href="man/symbolic.html">Symbolic Computation</a></li><li><a class="tocitem" href="man/cuda.html">CUDA extension - CuYao</a></li><li><a class="tocitem" href="man/plot.html">Quantum Circuit Visualization</a></li><li><a class="tocitem" href="man/automatic_differentiation.html">Automatic Differentiation</a></li><li><a class="tocitem" href="man/yao2einsum.html">Tensor network backend</a></li><li><a class="tocitem" href="man/simplification.html">Simplification</a></li><li><a class="tocitem" href="man/bitbasis.html">BitBasis</a></li></ul></li><li><span class="tocitem">Examples</span><ul><li><a class="tocitem" href="generated/examples/1.prepare-ghz-state/index.html">Prepare Greenberger–Horne–Zeilinger state with Quantum Circuit</a></li><li><a class="tocitem" href="generated/examples/2.qft-phase-estimation/index.html">Quantum Fourier Transformation and Phase Estimation</a></li><li><a class="tocitem" href="generated/examples/3.grover-search/index.html">Grover Search</a></li><li><a class="tocitem" href="generated/examples/4.shor-algorithm/index.html">Shor's Algorithm</a></li><li><a class="tocitem" href="generated/examples/5.shor-9-code/index.html">Shor's 9 qubit code</a></li><li><a class="tocitem" href="generated/examples/6.quantum-circuit-born-machine/index.html">Quantum Circuit Born Machine</a></li><li><a class="tocitem" href="generated/examples/7.variation-quantum-eigen-solver/index.html">Variational Quantum Eigen Solver</a></li><li><a class="tocitem" href="generated/examples/8.riemannian-gradient-flow/index.html">Riemannian gradient flow optimizer</a></li></ul></li><li><a class="tocitem" href="performancetips.html">Performance Tips</a></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="index.html">Home</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href="index.html">Home</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/QuantumBFS/Yao.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/QuantumBFS/Yao.jl/blob/master/docs/src/index.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="Yao"><a class="docs-heading-anchor" href="#Yao">Yao</a><a id="Yao-1"></a><a class="docs-heading-anchor-permalink" href="#Yao" title="Permalink"></a></h1><p><em>A General Purpose Quantum Computation Simulation Framework</em></p><p>Welcome to <a href="https://github.com/QuantumBFS/Yao.jl">Yao</a>, a <strong>Flexible</strong>, <strong>Extensible</strong>, <strong>Efficient</strong> Framework for Quantum Algorithm Design. <strong>Yao</strong> (幺) is the Chinese character for normalized but not orthogonal.</p><p>We aim to provide a powerful tool for researchers, students to study and explore quantum computing in near term future, before quantum computer being used in large-scale.</p><h2 id="Quick-Starts"><a class="docs-heading-anchor" href="#Quick-Starts">Quick Starts</a><a id="Quick-Starts-1"></a><a class="docs-heading-anchor-permalink" href="#Quick-Starts" title="Permalink"></a></h2><p>You can learn how to use Yao with some quick examples in this section. There are three badges on the top of each tutorial that allows you to open it in <a href="https://mybinder.org/">mybinder</a>, preview it in <a href="https://nbviewer.jupyter.org/">nbviewer</a> or download the tutorial as <code>.zip</code> file, which includes the notebook and the scripts and other related materials.</p><h3 id="Contribution"><a class="docs-heading-anchor" href="#Contribution">Contribution</a><a id="Contribution-1"></a><a class="docs-heading-anchor-permalink" href="#Contribution" title="Permalink"></a></h3><p>If you are interesting in polishing or contributing our tutorial, you can just open a <a href="https://github.com/QuantumBFS/tutorials/compare">PR in our tutorial repo</a>.</p><h3 id="Syntax"><a class="docs-heading-anchor" href="#Syntax">Syntax</a><a id="Syntax-1"></a><a class="docs-heading-anchor-permalink" href="#Syntax" title="Permalink"></a></h3><p>The tutorials are written with <a href="https://github.com/fredrikekre/Literate.jl">Literate</a>.</p><h2 id="Pluto-Notebooks"><a class="docs-heading-anchor" href="#Pluto-Notebooks">Pluto Notebooks</a><a id="Pluto-Notebooks-1"></a><a class="docs-heading-anchor-permalink" href="#Pluto-Notebooks" title="Permalink"></a></h2><p>There is also a set of Pluto notebooks available in <a href="notebooks">the notebooks folder</a></p><h2 id="Manual"><a class="docs-heading-anchor" href="#Manual">Manual</a><a id="Manual-1"></a><a class="docs-heading-anchor-permalink" href="#Manual" title="Permalink"></a></h2><ul><li><a href="man/blocks.html#Blocks">Blocks</a></li><li><a href="man/registers.html#registers">Quantum Registers</a></li></ul></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="quick-start.html">Quick Start »</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></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.4.1 on <span class="colophon-date" title="Monday 13 May 2024 16:32">Monday 13 May 2024</span>. Using Julia version 1.10.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>