Add links and instructions on running with Quantum Mobile images #588
Conversation
unkcpz
force-pushed
the
doc/xx/add-qm-links
branch
from
5349158
to
28b2c90
Compare
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #588 +/- ##
=======================================
Coverage 80.86% 80.86%
=======================================
Files 49 49
Lines 3429 3429
=======================================
Hits 2773 2773
Misses 656 656
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
unkcpz
force-pushed
the
doc/xx/add-qm-links
branch
2 times, most recently
from
94db42f
to
060fefe
Compare
unkcpz
force-pushed
the
doc/xx/add-qm-links
branch
from
060fefe
to
2ad66ff
Compare
| @@ -4,9 +4,49 @@ Virtual Machine Image | |||
|
|
|||
| .. note:: | |||
|
|
|||
| If you used another method to access AiiDAlab, you may proceed to :doc:`install the app </installation/install>`. | |||
| If you uses another method to access AiiDAlab, you may proceed to :doc:`install the app </installation/install>`. | |||
There was a problem hiding this comment.
"used" is correct. Also, note that this note appears in several places in the site. We need to be consistent.
|
|
||
| The AiiDAlab virtual image based on `Quantum Mobile <https://quantum-mobile.readthedocs.io/>`_ is available for the following architectures: | ||
| The AiiDAlab Quantum ESPRESSO virtual image based on `Quantum Mobile <https://quantum-mobile.readthedocs.io/>`_ is available for the following architectures: |
There was a problem hiding this comment.
When using "the following...:", ideally you should follow with a list. I recommend you add a bullet-point list with just the names, then add "See the following sections for instructions pertaining to your architecture." or something like it.
Also, maybe break down the sentence a bit - "The AiiDAlab Quantum ESPRESSO virtual image is based on the Quantum Mobile <https://quantum-mobile.readthedocs.io/>_ image and is available for the following architectures:"
|
|
||
| Get AiiDAlab Quantum ESPRESSO virtual machine running on your computer in three simple steps: | ||
|
|
||
| #. Step1: Download virtual machine image (4.09 GB) |
There was a problem hiding this comment.
It's already a numbered list. No need for "step1", etc.
|
|
||
| Get AiiDAlab Quantum ESPRESSO virtual machine running on your computer in three simple steps: | ||
|
|
||
| #. Step1: Download virtual machine image (4.09 GB) |
There was a problem hiding this comment.
"Download THE virtual machine...." - same in step 3
| M1/M2 apple silicon | ||
| ------------------- | ||
|
|
||
| If you have an M1/M2 apple silicon, you can use `UTM <https://mac.getutm.app/>`_ to run the AiiDAlab Quantum ESPRESSO virtual machine. The steps are as follows: |
There was a problem hiding this comment.
Should apple and silicon be capitalized? I believe these are proper names of a chip, right? Also, add "chip" after silicon
|
|
||
| If you have an M1/M2 apple silicon, you can use `UTM <https://mac.getutm.app/>`_ to run the AiiDAlab Quantum ESPRESSO virtual machine. The steps are as follows: | ||
|
|
||
| #. Step1: Download compressed virtual machine image (5.9 GB) |
There was a problem hiding this comment.
Same comments as above regarding "step1" and "THE"
|
|
||
| #. Step2: Decompress the zip file. | ||
| #. Step3: Install UTM (see https://mac.getutm.app/) | ||
| #. Step4 Import image into UTM by clicking on the Create a New Virtual Machine button and selecting the `quantum_mobile_23.10.0-qeapp.utm` file. |
There was a problem hiding this comment.
Italicize "Create a New Virtual Machine" for emphasis
| + MD5 hash: `5c80d9ab2458f2edac30e97dc2fe36e7` | ||
|
|
||
| #. Step2: Install Virtual Box 6.1.6 or later (see https://www.virtualbox.org) | ||
| #. Step3: Import virtual machine image into Virtualbox (11.2 GB) File => Import Appliance |
There was a problem hiding this comment.
Italicize "Import appliance" for emphasis
|
Thanks for the review @edan-bainglass. All comments addressed. It is a very good English writing skills lesson for me. 😄 |
|
Thanks @edan-bainglass |
Link and instructions for: