Commit da8e7069 authored by Mccaskey, Alex's avatar Mccaskey, Alex
Browse files

adding docker dev docs


Signed-off-by: Mccaskey, Alex's avatarAlex McCaskey <mccaskeyaj@ornl.gov>
parent 3add29c7
Pipeline #80440 passed with stage
in 3 minutes and 53 seconds
......@@ -6,6 +6,19 @@ This can be done from both C++ and Python.
Quick Start with Docker
-----------------------
We have put together a docker image based on Ubuntu 18.04 that has all required
dependencies for building XACC. Moreover, we have set this image up to serve an
Eclipse Theia IDE on ``localhost:3000``. To use this image run the following from some
scratch development directory:
.. code:: bash
$ docker run -it --init -p 3000:3000 -v "$(pwd):/home/project:cached" xacc/dev
Now navigate to ``localhost:3000`` in your web browser. This will open
the Theia IDE and you are good to go. Open a terminal with ``ctrl + ```
(or ``cmd + ``` on a Mac). Use the terminal to clone XACC and start
building.
Quick Start for ORNL Developers
-------------------------------
......@@ -301,16 +314,6 @@ service.
# should have 4 instructions, not 6
assert(4 == f.nInstructions())
......
......@@ -701,6 +701,10 @@ RDMPurificationDecorator
ImprovedSamplingDecorator
+++++++++++++++++++++++++
VQE Restart Decorator
+++++++++++++++++++++
IR Transformations
------------------
......
......@@ -7,6 +7,13 @@ describe the build process with the Python API enabled. For this you will need a
development install. To interact with remote QPUs, you will need CURL with OpenSSL development
headers and libraries.
Quick-Start with Docker
-----------------------
To get up and running quickly and avoid installing the prerequisites you can
pull the ``xacc/dev`` Docker image (see `here <https://xacc.readthedocs.io/en/latest/developers.html#quick-start-with-docker>`_ for instructions).
Once you have the IDE up and running, you can skip down to `cloning XACC <https://xacc.readthedocs.io/en/latest/install.html#build-xacc>`_.
Prerequisites
-------------
Ubuntu 16.04
......
......@@ -168,6 +168,17 @@ with new Compilers, Accelerators, Instructions, IR Transformations, etc.
This can be done from both C++ and Python.</p>
<div class="section" id="quick-start-with-docker">
<h2>Quick Start with Docker<a class="headerlink" href="#quick-start-with-docker" title="Permalink to this headline"></a></h2>
<p>We have put together a docker image based on Ubuntu 18.04 that has all required
dependencies for building XACC. Moreover, we have set this image up to serve an
Eclipse Theia IDE on <code class="docutils literal notranslate"><span class="pre">localhost:3000</span></code>. To use this image run the following from some
scratch development directory:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ docker run -it --init -p <span class="m">3000</span>:3000 -v <span class="s2">&quot;</span><span class="k">$(</span><span class="nb">pwd</span><span class="k">)</span><span class="s2">:/home/project:cached&quot;</span> xacc/dev
</pre></div>
</div>
<p>Now navigate to <code class="docutils literal notranslate"><span class="pre">localhost:3000</span></code> in your web browser. This will open
the Theia IDE and you are good to go. Open a terminal with <code class="docutils literal notranslate"><span class="pre">ctrl</span> <span class="pre">+</span> <span class="pre">`</span></code>
(or <code class="docutils literal notranslate"><span class="pre">cmd</span> <span class="pre">+</span> <span class="pre">`</span></code> on a Mac). Use the terminal to clone XACC and start
building.</p>
</div>
<div class="section" id="quick-start-for-ornl-developers">
<h2>Quick Start for ORNL Developers<a class="headerlink" href="#quick-start-for-ornl-developers" title="Permalink to this headline"></a></h2>
......
......@@ -112,6 +112,7 @@
<li class="toctree-l3"><a class="reference internal" href="#roerrordecorator">ROErrorDecorator</a></li>
<li class="toctree-l3"><a class="reference internal" href="#rdmpurificationdecorator">RDMPurificationDecorator</a></li>
<li class="toctree-l3"><a class="reference internal" href="#improvedsamplingdecorator">ImprovedSamplingDecorator</a></li>
<li class="toctree-l3"><a class="reference internal" href="#vqe-restart-decorator">VQE Restart Decorator</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#ir-transformations">IR Transformations</a><ul>
......@@ -1081,6 +1082,9 @@ for a full example demonstrating the utility of the <code class="docutils litera
<div class="section" id="improvedsamplingdecorator">
<h3>ImprovedSamplingDecorator<a class="headerlink" href="#improvedsamplingdecorator" title="Permalink to this headline"></a></h3>
</div>
<div class="section" id="vqe-restart-decorator">
<h3>VQE Restart Decorator<a class="headerlink" href="#vqe-restart-decorator" title="Permalink to this headline"></a></h3>
</div>
</div>
<div class="section" id="ir-transformations">
<h2>IR Transformations<a class="headerlink" href="#ir-transformations" title="Permalink to this headline"></a></h2>
......
......@@ -212,6 +212,7 @@ You can ask questions by creating a new issue with the question tag.</p>
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="install.html">Installation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="install.html#quick-start-with-docker">Quick-Start with Docker</a></li>
<li class="toctree-l2"><a class="reference internal" href="install.html#prerequisites">Prerequisites</a><ul>
<li class="toctree-l3"><a class="reference internal" href="install.html#ubuntu-16-04">Ubuntu 16.04</a></li>
<li class="toctree-l3"><a class="reference internal" href="install.html#ubuntu-18-04">Ubuntu 18.04</a></li>
......@@ -257,6 +258,7 @@ You can ask questions by creating a new issue with the question tag.</p>
<li class="toctree-l3"><a class="reference internal" href="extensions.html#roerrordecorator">ROErrorDecorator</a></li>
<li class="toctree-l3"><a class="reference internal" href="extensions.html#rdmpurificationdecorator">RDMPurificationDecorator</a></li>
<li class="toctree-l3"><a class="reference internal" href="extensions.html#improvedsamplingdecorator">ImprovedSamplingDecorator</a></li>
<li class="toctree-l3"><a class="reference internal" href="extensions.html#vqe-restart-decorator">VQE Restart Decorator</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="extensions.html#ir-transformations">IR Transformations</a><ul>
......
......@@ -87,6 +87,7 @@
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">Installation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#quick-start-with-docker">Quick-Start with Docker</a></li>
<li class="toctree-l2"><a class="reference internal" href="#prerequisites">Prerequisites</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#ubuntu-16-04">Ubuntu 16.04</a></li>
<li class="toctree-l3"><a class="reference internal" href="#ubuntu-18-04">Ubuntu 18.04</a></li>
......@@ -173,6 +174,12 @@ recommend installing with the Python API (although you may choose not to). This
describe the build process with the Python API enabled. For this you will need a Python 3 executable and
development install. To interact with remote QPUs, you will need CURL with OpenSSL development
headers and libraries.</p>
<div class="section" id="quick-start-with-docker">
<h2>Quick-Start with Docker<a class="headerlink" href="#quick-start-with-docker" title="Permalink to this headline"></a></h2>
<p>To get up and running quickly and avoid installing the prerequisites you can
pull the <code class="docutils literal notranslate"><span class="pre">xacc/dev</span></code> Docker image (see <a class="reference external" href="https://xacc.readthedocs.io/en/latest/developers.html#quick-start-with-docker">here</a> for instructions).
Once you have the IDE up and running, you can skip down to <a class="reference external" href="https://xacc.readthedocs.io/en/latest/install.html#build-xacc">cloning XACC</a>.</p>
</div>
<div class="section" id="prerequisites">
<h2>Prerequisites<a class="headerlink" href="#prerequisites" title="Permalink to this headline"></a></h2>
<div class="section" id="ubuntu-16-04">
......
This diff is collapsed.
......@@ -6,6 +6,19 @@ This can be done from both C++ and Python.
Quick Start with Docker
-----------------------
We have put together a docker image based on Ubuntu 18.04 that has all required
dependencies for building XACC. Moreover, we have set this image up to serve an
Eclipse Theia IDE on ``localhost:3000``. To use this image run the following from some
scratch development directory:
.. code:: bash
$ docker run -it --init -p 3000:3000 -v "$(pwd):/home/project:cached" xacc/dev
Now navigate to ``localhost:3000`` in your web browser. This will open
the Theia IDE and you are good to go. Open a terminal with ``ctrl + ```
(or ``cmd + ``` on a Mac). Use the terminal to clone XACC and start
building.
Quick Start for ORNL Developers
-------------------------------
......
......@@ -7,6 +7,13 @@ describe the build process with the Python API enabled. For this you will need a
development install. To interact with remote QPUs, you will need CURL with OpenSSL development
headers and libraries.
Quick-Start with Docker
-----------------------
To get up and running quickly and avoid installing the prerequisites you can
pull the ``xacc/dev`` Docker image (see `here <https://xacc.readthedocs.io/en/latest/developers.html#quick-start-with-docker>`_ for instructions).
Once you have the IDE up and running, you can skip down to `cloning XACC <https://xacc.readthedocs.io/en/latest/install.html#build-xacc>`_.
Prerequisites
-------------
Ubuntu 16.04
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment