deploy: 40e66d3

king-p3nguin · May 31, 2024 · 0a997e2 · 0a997e2
commit 0a997e2
Show file tree

Hide file tree

Showing 136 changed files with 38,612 additions and 0 deletions.
diff --git a/.buildinfo b/.buildinfo
@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 4405d5f16b5806a74936fbdab5d8eead
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/.nojekyll b/.nojekyll
diff --git a/CONTRIBUTIONS.html b/CONTRIBUTIONS.html
diff --git a/README.html b/README.html
@@ -0,0 +1,203 @@
+<!DOCTYPE html>
+<html class="writer-html5" lang="en" data-content_root="./">
+<head>
+  <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
+
+  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+  <title>Install &mdash; tangelo 0.4.3 documentation</title>
+      <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
+      <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
+      <link rel="stylesheet" type="text/css" href="_static/css/custom.css?v=c473181c" />
+
+
+  <!--[if lt IE 9]>
+    <script src="_static/js/html5shiv.min.js"></script>
+  <![endif]-->
+
+        <script src="_static/jquery.js?v=5d32c60e"></script>
+        <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
+        <script src="_static/documentation_options.js?v=5bfaad31"></script>
+        <script src="_static/doctools.js?v=9a2dae69"></script>
+        <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
+        <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
+    <script src="_static/js/theme.js"></script>
+    <link rel="index" title="Index" href="genindex.html" />
+    <link rel="search" title="Search" href="search.html" /> 
+</head>
+
+<body class="wy-body-for-nav"> 
+  <div class="wy-grid-for-nav">
+    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+      <div class="wy-side-scroll">
+        <div class="wy-side-nav-search" >
+
+
+
+          <a href="index.html" class="icon icon-home">
+            tangelo
+              <img src="_static/tangelo_logo_white.png" class="logo" alt="Logo"/>
+          </a>
+<div role="search">
+  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
+    <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
+    <input type="hidden" name="check_keywords" value="yes" />
+    <input type="hidden" name="area" value="default" />
+  </form>
+</div>
+        </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
+              <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="overview.html">Overview</a></li>
+<li class="toctree-l1"><a class="reference internal" href="TUTORIALS.html">Tutorials</a></li>
+<li class="toctree-l1"><a class="reference internal" href="CONTRIBUTIONS.html">Contributions guidelines</a></li>
+<li class="toctree-l1"><a class="reference internal" href="tangelo.html">tangelo package</a></li>
+</ul>
+
+        </div>
+      </div>
+    </nav>
+
+    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
+          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+          <a href="index.html">tangelo</a>
+      </nav>
+
+      <div class="wy-nav-content">
+        <div class="rst-content">
+          <div role="navigation" aria-label="Page navigation">
+  <ul class="wy-breadcrumbs">
+      <li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
+      <li class="breadcrumb-item active">Install</li>
+      <li class="wy-breadcrumbs-aside">
+            <a href="_sources/README.rst.txt" rel="nofollow"> View page source</a>
+      </li>
+  </ul>
+  <hr/>
+</div>
+          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+           <div itemprop="articleBody">
+
+  <p align="center">
+  <img width="600" alt="tangelo_logo" src="./docs/source/_static/img/tangelo_logo_gradient.png">
+</p><p align="center">
+  <a href="https://github.com/goodchemistryco/Tangelo/blob/main/LICENSE">
+    <img src="https://img.shields.io/badge/License-Apache_2.0-green" alt="license">
+  </a>
+  <img src="https://img.shields.io/badge/OS-Linux%20MacOS%20Windows-7373e3" alt="systems">
+  <a href="https://github.com/goodchemistryco/Tangelo/tree/develop">
+    <img src="https://img.shields.io/badge/DevBranch-develop-yellow" alt="dev_branch">
+  </a>
+</p><p>Tangelo is an open-source Python package maintained by <a class="reference external" href="https://www.sandboxaq.com/">SandboxAQ</a>, focusing on the development of quantum chemistry simulation workflows on quantum computers. It was developed as an engine to accelerate research, and takes advantage of other popular frameworks to harness the innovation in our field.</p>
+<hr class="docutils" />
+<h3 align="center">
+  <a href="https://github.com/goodchemistryco/Tangelo-Examples/blob/main/contents.rst" target="_blank"><b>Tutorials</b></a>
+&nbsp;&#183;&nbsp;
+  <a href="https://github.com/goodchemistryco/Tangelo/blob/develop/docs/source/docs/source/_static/img/tangelo_feature_overview.jpeg?raw=true" target="_blank"><b>Features</b></a>
+&nbsp;&#183;&nbsp;
+  <a href="http://tangelo-docs.goodchemistry.com" target="_blank"><b>Docs</b></a>
+&nbsp;&#183;&nbsp;
+  <a href="https://goodchemistry.com/blog/" target="_blank"><b>Blog</b></a>
+</h3><hr class="docutils" />
+<p>This package provides a collection of algorithms and toolboxes to support quantum algorithms R&amp;D and the design of successful experiments on quantum devices. Tangelo is backend-agnostic, which means users can write quantum algortihms once and run their calculations on current and future platforms with minimal changes. Tangelo is capable to perform quantum experiments that led to publications in scientific journals, co-authored by professionals from the chemical industry and quantum hardware manufacturers.</p>
+<p align="center">
+  <img width="700" alt="tangelo_workflow" src="./docs/source/_static/img/quantum_workflow.png">
+</p><hr class="docutils" />
+<section id="install">
+<h1>Install<a class="headerlink" href="#install" title="Link to this heading"></a></h1>
+<section id="using-pip">
+<h2>1. Using pip<a class="headerlink" href="#using-pip" title="Link to this heading"></a></h2>
+<p>The easiest way to install Tangelo in your local environment.</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">python</span> <span class="o">-</span><span class="n">m</span> <span class="n">pip</span> <span class="n">install</span> <span class="o">--</span><span class="n">upgrade</span> <span class="n">pip</span><span class="o">.</span>
+<span class="n">pip</span> <span class="n">install</span> <span class="n">tangelo</span><span class="o">-</span><span class="n">gc</span>
+</pre></div>
+</div>
+<p>If you’d like to install via pip the code in a specific branch of this Github repository (let’s say <code class="docutils literal notranslate"><span class="pre">develop</span></code>, which is usually the most advanced):</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pip</span> <span class="n">install</span> <span class="n">git</span><span class="o">+</span><span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">github</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">goodchemistryco</span><span class="o">/</span><span class="n">Tangelo</span><span class="o">.</span><span class="n">git</span><span class="nd">@develop</span>
+</pre></div>
+</div>
+</section>
+<section id="from-source-using-setuptools">
+<h2>2. From source, using setuptools<a class="headerlink" href="#from-source-using-setuptools" title="Link to this heading"></a></h2>
+<p>After downloading the contents of this repo, you can install Tangelo using the following command, which uses <code class="docutils literal notranslate"><span class="pre">setup.py</span></code>:</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">python</span> <span class="o">-</span><span class="n">m</span> <span class="n">pip</span> <span class="n">install</span> <span class="o">.</span>
+</pre></div>
+</div>
+</section>
+<section id="optional-dependencies-quantum-simulators-and-classical-quantum-chemistry">
+<h2>Optional dependencies: Quantum Simulators and Classical Quantum Chemistry<a class="headerlink" href="#optional-dependencies-quantum-simulators-and-classical-quantum-chemistry" title="Link to this heading"></a></h2>
+<p>Tangelo enables users to target various backends. In particular, it integrates quantum circuit simulators such as <code class="docutils literal notranslate"><span class="pre">qulacs</span></code>, <code class="docutils literal notranslate"><span class="pre">qiskit</span></code>, <code class="docutils literal notranslate"><span class="pre">cirq</span></code>, among others. We leave it to you to install the packages of your choice, and refer to their own documentation. Most packages can be installed through pip or conda easily.
+Tangelo can be used without having a classical quantum chemistry package installed but many chemistry algorithms need one. The two quantum chemistry packages that are natively supported are <a class="reference external" href="https://pyscf.org/">PySCF</a> and <a class="reference external" href="https://psicode.org/">Psi4</a>, which can be installed through pip or conda. It is possible to plug in your own pre-computed integrals and other chemistry calculations done with the tools of your choice, or your own compute backend for executing quantum algorithms.</p>
+</section>
+<section id="optional-environment-variables">
+<h2>Optional: environment variables<a class="headerlink" href="#optional-environment-variables" title="Link to this heading"></a></h2>
+<p>The bash file <code class="docutils literal notranslate"><span class="pre">env_var.sh</span></code> shows a number of environment variables used in Tangelo, for purposes such as computational performance or credentials for quantum experiments.
+You can either source this file in your terminal, or set these variables inside your python script / notebooks using the <code class="docutils literal notranslate"><span class="pre">os</span></code> package.</p>
+</section>
+</section>
+<section id="tutorials-and-examples">
+<h1>Tutorials and examples<a class="headerlink" href="#tutorials-and-examples" title="Link to this heading"></a></h1>
+<p>We have a <a class="reference external" href="https://github.com/goodchemistryco/Tangelo-Examples">dedicated repository</a> for examples and tutorials ! You can get started with just a few clicks.
+Tutorials are organized following a colorful tag system to help people find what is relevant to them. They contain insightful information and advice about chemistry simulations, quantum computing experiments and using Tangelo. Tangelo users can also contribute to this repository and showcase their own work.</p>
+<p>Check out our <a class="reference internal" href="TUTORIALS.html"><span class="doc">tutorials</span></a> file for more details.</p>
+</section>
+<section id="tests">
+<h1>Tests<a class="headerlink" href="#tests" title="Link to this heading"></a></h1>
+<p>Unit tests can be found in the <code class="docutils literal notranslate"><span class="pre">tests</span></code> folders, located in the various toolboxes they are related to. To automatically find and run all tests (some tests will fail or be skipped if a dependency is not installed):</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">python</span> <span class="o">-</span><span class="n">m</span> <span class="n">unittest</span>
+</pre></div>
+</div>
+</section>
+<section id="contributions">
+<h1>Contributions<a class="headerlink" href="#contributions" title="Link to this heading"></a></h1>
+<p>Thank you very much for considering contributing to this project; we’d love to have you on board !
+You do not need to be a seasoned software developer or expert in your field to make contributions to this project: it will take various kinds of people and backgrounds to tackle the challenges that await us.</p>
+<p>You can use the <a class="reference external" href="https://github.com/goodchemistryco/Tangelo/issues">Issue tab</a> to open a bug report or feature request. Starting a discussion in the <a class="reference external" href="https://github.com/goodchemistryco/Tangelo/discussions">Discussion tab</a> is also a good start: we’ll figure it out from there.</p>
+<p>The contribution process is detailed in the <a class="reference internal" href="CONTRIBUTIONS.html"><span class="doc">contributions</span></a> file. Don’t feel intimidated: we work at the intersection of many difficult fields and we’re here to help. By joining the Tangelo community and sharing your ideas and developments, you are creating an opportunity for us to grow together, and take ideas to the finish line and beyond.</p>
+</section>
+<section id="citations">
+<h1>Citations<a class="headerlink" href="#citations" title="Link to this heading"></a></h1>
+<p>If you use Tangelo in your research, please cite the <a class="reference external" href="https://arxiv.org/abs/2206.12424">Tangelo release paper</a> and consider mentioning Tangelo in your talks.</p>
+<div class="highlight-latex notranslate"><div class="highlight"><pre><span></span>@article<span class="nb">{</span>tangelo,
+   author = <span class="nb">{</span>Valentin Senicourt and James Brown and Alexandre Fleury and Ryan Day and Erika Lloyd and Marc P. Coons and Krzysztof Bieniasz and Lee Huntington and Alejandro J. Garza and Shunji Matsuura and Rudi Plesch and Takeshi Yamazaki and Arman Zaribafiyan<span class="nb">}</span>,
+   title = <span class="nb">{</span>Tangelo: An Open-source Python Package for End-to-end Chemistry Workflows on Quantum Computers<span class="nb">}</span>,
+   year = <span class="nb">{</span>2022<span class="nb">}</span>,
+   url= <span class="nb">{</span>https://arxiv.org/abs/2206.12424<span class="nb">}</span>,
+   number = <span class="nb">{</span>arXiv:2206.12424<span class="nb">}</span>,
+   eprint = <span class="nb">{</span>arXiv:2206.12424<span class="nb">}</span>,
+   publisher = <span class="nb">{{</span>arXiv<span class="nb">}}</span>,
+   doi = <span class="nb">{</span>10.48550/arXiv.2206.12424<span class="nb">}</span>
+<span class="nb">}</span>
+</pre></div>
+</div>
+<p>© SandboxAQ 2024. This software is released under the Apache Software License version 2.0.</p>
+</section>
+
+
+           </div>
+          </div>
+          <footer>
+
+  <hr/>
+
+  <div role="contentinfo">
+    <p>&#169; Copyright SandboxAQ 2021-2024.</p>
+  </div>
+
+  Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
+    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
+    provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+
+</footer>
+        </div>
+      </div>
+    </section>
+  </div>
+  <script>
+      jQuery(function () {
+          SphinxRtdTheme.Navigation.enable(true);
+      });
+  </script> 
+
+</body>
+</html>