Commit 5500c664 authored by Mccaskey, Alex's avatar Mccaskey, Alex
Browse files

adding quick start ornl dev docs


Signed-off-by: Mccaskey, Alex's avatarAlex McCaskey <mccaskeyaj@ornl.gov>
parent da8e7069
Pipeline #80445 passed with stage
in 3 minutes and 49 seconds
......@@ -18,10 +18,36 @@ scratch development directory:
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.
building.
Quick Start for ORNL Developers
-------------------------------
For ORNL employees (or those with valid ORNL credentials) we have put together
a base Ubuntu 16.04 VM image that can be used with the `CADES Cloud Computing
infrastructure <https://cades.ornl.gov/service-suite/cades-cloud/>`_. CADES provides a
form of cloud computing whereby users can spin up VMs of varying sizes (n cpus, RAM, etc)
via a user-friendly web interface. Once created, users can SSH into it and begin working. Our base
Ubuntu VM comes with all XACC prerequisites and the Eclipse Theia IDE installed.
If you would like to leverage this service, please request an account by following the instructions
`here <https://support.cades.ornl.gov/user-documentation/_book/quick-starts/launch-vm-quick-start.html>`_.
Once you have an account, email `mccaskeyaj@ornl.gov <mccaskeyaj@ornl.gov>`_ and request access to the base XACC image.
Once your VM is created, you need to open up port 3000 in order to use Theia. To do so, go to the CADES web dashboard
and click Access and Security. On the default security group click Manage Rules. At the top, click Add Rule, leave everything
as it is by default, but add ``3000`` to the port entry. Now just click Add Rule.
Continue to read through the support `site <https://support.cades.ornl.gov/user-documentation/_book/openstack/access-vm/access-vm.html>`_
to see information about SSHing into your newly created VM. Once logged into the VM, run the following to launch Theia
.. code:: bash
$ cd dev
$ yarn theia start --hostname 0.0.0.0 --port 3000
Launch this in the background if you wish to leave the current SSH session but still want Theia running on
your VM. Now navigate to your instances IP address at port 3000 in your web browser (``https://128.232.33.87:3000`` for example).
You should see the Theia web IDE. Now build XACC according to the instructions `here <https://xacc.readthedocs.io/en/latest/install.html#build-xacc>`_.
Writing a Plugin in C++
-----------------------
......
......@@ -182,6 +182,27 @@ 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>
<p>For ORNL employees (or those with valid ORNL credentials) we have put together
a base Ubuntu 16.04 VM image that can be used with the <a class="reference external" href="https://cades.ornl.gov/service-suite/cades-cloud/">CADES Cloud Computing
infrastructure</a>. CADES provides a
form of cloud computing whereby users can spin up VMs of varying sizes (n cpus, RAM, etc)
via a user-friendly web interface. Once created, users can SSH into it and begin working. Our base
Ubuntu VM comes with all XACC prerequisites and the Eclipse Theia IDE installed.</p>
<p>If you would like to leverage this service, please request an account by following the instructions
<a class="reference external" href="https://support.cades.ornl.gov/user-documentation/_book/quick-starts/launch-vm-quick-start.html">here</a>.
Once you have an account, email <a class="reference external" href="mailto:mccaskeyaj&#37;&#52;&#48;ornl&#46;gov">mccaskeyaj<span>&#64;</span>ornl<span>&#46;</span>gov</a> and request access to the base XACC image.</p>
<p>Once your VM is created, you need to open up port 3000 in order to use Theia. To do so, go to the CADES web dashboard
and click Access and Security. On the default security group click Manage Rules. At the top, click Add Rule, leave everything
as it is by default, but add <code class="docutils literal notranslate"><span class="pre">3000</span></code> to the port entry. Now just click Add Rule.</p>
<p>Continue to read through the support <a class="reference external" href="https://support.cades.ornl.gov/user-documentation/_book/openstack/access-vm/access-vm.html">site</a>
to see information about SSHing into your newly created VM. Once logged into the VM, run the following to launch Theia</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ <span class="nb">cd</span> dev
$ yarn theia start --hostname <span class="m">0</span>.0.0.0 --port <span class="m">3000</span>
</pre></div>
</div>
<p>Launch this in the background if you wish to leave the current SSH session but still want Theia running on
your VM. Now navigate to your instances IP address at port 3000 in your web browser (<code class="docutils literal notranslate"><span class="pre">https://128.232.33.87:3000</span></code> for example).
You should see the Theia web IDE. Now build XACC according to the instructions <a class="reference external" href="https://xacc.readthedocs.io/en/latest/install.html#build-xacc">here</a>.</p>
</div>
<div class="section" id="writing-a-plugin-in-c">
<h2>Writing a Plugin in C++<a class="headerlink" href="#writing-a-plugin-in-c" title="Permalink to this headline"></a></h2>
......
This diff is collapsed.
......@@ -18,10 +18,36 @@ scratch development directory:
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.
building.
Quick Start for ORNL Developers
-------------------------------
For ORNL employees (or those with valid ORNL credentials) we have put together
a base Ubuntu 16.04 VM image that can be used with the `CADES Cloud Computing
infrastructure <https://cades.ornl.gov/service-suite/cades-cloud/>`_. CADES provides a
form of cloud computing whereby users can spin up VMs of varying sizes (n cpus, RAM, etc)
via a user-friendly web interface. Once created, users can SSH into it and begin working. Our base
Ubuntu VM comes with all XACC prerequisites and the Eclipse Theia IDE installed.
If you would like to leverage this service, please request an account by following the instructions
`here <https://support.cades.ornl.gov/user-documentation/_book/quick-starts/launch-vm-quick-start.html>`_.
Once you have an account, email `mccaskeyaj@ornl.gov <mccaskeyaj@ornl.gov>`_ and request access to the base XACC image.
Once your VM is created, you need to open up port 3000 in order to use Theia. To do so, go to the CADES web dashboard
and click Access and Security. On the default security group click Manage Rules. At the top, click Add Rule, leave everything
as it is by default, but add ``3000`` to the port entry. Now just click Add Rule.
Continue to read through the support `site <https://support.cades.ornl.gov/user-documentation/_book/openstack/access-vm/access-vm.html>`_
to see information about SSHing into your newly created VM. Once logged into the VM, run the following to launch Theia
.. code:: bash
$ cd dev
$ yarn theia start --hostname 0.0.0.0 --port 3000
Launch this in the background if you wish to leave the current SSH session but still want Theia running on
your VM. Now navigate to your instances IP address at port 3000 in your web browser (``https://128.232.33.87:3000`` for example).
You should see the Theia web IDE. Now build XACC according to the instructions `here <https://xacc.readthedocs.io/en/latest/install.html#build-xacc>`_.
Writing a Plugin in C++
-----------------------
......
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