Skip to content

Commit

Permalink
deploy: ff1fa2e
Browse files Browse the repository at this point in the history
  • Loading branch information
shanto268 committed Oct 1, 2024
1 parent 3154659 commit f6e10df
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 15 deletions.
2 changes: 1 addition & 1 deletion .buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +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: b91d7db8160805d28846aca98b9db93f
config: a29c61beebae2b3274d04ccc2a289095
tags: 645f666f9bcd5a90fca523b33c5a78b7
2 changes: 0 additions & 2 deletions _sources/source/getting_started.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,6 @@ Installation

There are multiple ways to install SQuADDS. Choose the method that best suits your environment.

.. contents::
:local:

Install using pip
-----------------
Expand Down
16 changes: 4 additions & 12 deletions source/getting_started.html
Original file line number Diff line number Diff line change
Expand Up @@ -594,23 +594,15 @@ <h1>Getting Started with SQuADDS<a class="headerlink" href="#getting-started-wit
<section id="installation">
<h1>Installation<a class="headerlink" href="#installation" title="Link to this heading">#</a></h1>
<p>There are multiple ways to install SQuADDS. Choose the method that best suits your environment.</p>
<nav class="contents local" id="contents">
<ul class="simple">
<li><p><a class="reference internal" href="#install-using-pip" id="id1">Install using pip</a></p></li>
<li><p><a class="reference internal" href="#install-from-github" id="id2">Install from GitHub</a></p></li>
<li><p><a class="reference internal" href="#install-using-docker" id="id3">Install using Docker</a></p></li>
<li><p><a class="reference internal" href="#fresh-environment-installation" id="id4">Fresh Environment Installation</a></p></li>
</ul>
</nav>
<section id="install-using-pip">
<h2><a class="toc-backref" href="#id1" role="doc-backlink">Install using pip</a><a class="headerlink" href="#install-using-pip" title="Link to this heading">#</a></h2>
<h2>Install using pip<a class="headerlink" href="#install-using-pip" title="Link to this heading">#</a></h2>
<p>SQuADDS can be installed using pip in an environment with <cite>qiskit-metal</cite> pre-installed.</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pip<span class="w"> </span>install<span class="w"> </span>SQuADDS
</pre></div>
</div>
</section>
<section id="install-from-github">
<h2><a class="toc-backref" href="#id2" role="doc-backlink">Install from GitHub</a><a class="headerlink" href="#install-from-github" title="Link to this heading">#</a></h2>
<h2>Install from GitHub<a class="headerlink" href="#install-from-github" title="Link to this heading">#</a></h2>
<p>Alternatively, you can install SQuADDS from source.</p>
<ol class="arabic">
<li><p><strong>Clone Repository</strong>: Navigate to your chosen directory and clone the repository.</p>
Expand All @@ -630,11 +622,11 @@ <h2><a class="toc-backref" href="#id2" role="doc-backlink">Install from GitHub</
</ol>
</section>
<section id="install-using-docker">
<h2><a class="toc-backref" href="#id3" role="doc-backlink">Install using Docker</a><a class="headerlink" href="#install-using-docker" title="Link to this heading">#</a></h2>
<h2>Install using Docker<a class="headerlink" href="#install-using-docker" title="Link to this heading">#</a></h2>
<p>You can use our Docker image to run SQuADDS. The Docker image is available <a class="reference external" href="https://github.com/LFL-Lab/SQuADDS/pkgs/container/squadds_env">here</a>. Instructions on how to use the Docker image can be found <a class="reference external" href="https://github.com/LFL-Lab/SQuADDS?tab=readme-ov-file#run-using-docker">here</a></p>
</section>
<section id="fresh-environment-installation">
<h2><a class="toc-backref" href="#id4" role="doc-backlink">Fresh Environment Installation</a><a class="headerlink" href="#fresh-environment-installation" title="Link to this heading">#</a></h2>
<h2>Fresh Environment Installation<a class="headerlink" href="#fresh-environment-installation" title="Link to this heading">#</a></h2>
<p>For installing SQuADDS (from PyPi) on a completely fresh environment on a UNIX machine, you can use the following shell script.</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="ch">#!/bin/bash</span>

Expand Down

0 comments on commit f6e10df

Please sign in to comment.