11# Quantum Mobile
22
3+ ## What is Quantum Mobile
4+
35* Quantum Mobile* is a Virtual Machine for computational materials science.
46
57It comes with a collection of software packages for quantum
@@ -16,37 +18,51 @@ all of which are set up and ready to be used through the
1618[ AiiDA] ( http://www.aiida.net ) python framework for automated workflows and
1719provenance tracking.
1820
21+ You can run Quantum Mobile on your Windows, MacOS or Linux computer using the
22+ [ VirtualBox] ( http://virtualbox.org/ ) software.
23+ You can also install Quantum Mobile on virtual machines using cloud services
24+ like Amazon Web Services or OpenStack.
25+
26+ ![ Demo] ( https://image.ibb.co/n50SdT/quantum_mobile.gif " A brief impression of the Quantum Mobile interface. ")
27+
1928## Download the VM
2029
21- Please see [ releases] ( https://github.com/marvel-nccr/quantum-mobile/releases ) for the latest VM image and installation instructions.
30+ Please see [ releases] ( https://github.com/marvel-nccr/quantum-mobile/releases )
31+ for the latest VM image and installation instructions.
2232
23- For issues encountered during installation of the VM, see the [ FAQ] ( https://github.com/marvel-nccr/quantum-mobile/wiki/Frequently-Asked-Questions ) .
33+ For issues encountered during installation of the VM, see the
34+ [ FAQ] ( https://github.com/marvel-nccr/quantum-mobile/wiki/Frequently-Asked-Questions ) .
2435
2536## Build it from scratch
2637
2738You would like to add/remove some components of the VM
2839and produce your own modified VM image?
2940
30- This git repository contains all the vagrant and ansible scripts
31- required to set up the VM from scratch (note: [ plan >1h] ( other_stuff/timings.txt ) for this).
41+ This git repository contains all the vagrant and ansible scripts required to
42+ set up the VM from scratch (note: [ plan >1h] ( other_stuff/timings.txt ) for
43+ this).
3244
3345### Prerequisites
3446
3547- [ vagrant] ( https://www.vagrantup.com/downloads.html ) >= 2.0.1
3648- [ virtualbox] ( https://www.virtualbox.org/wiki/Downloads )
3749- [ python] ( https://www.python.org/ )
38- - Host OS: Building VM tested only on Unix systems so far (MacOS, Ubuntu). Might work under Windows with a few modifications.
50+ - Host OS: Building VM tested only on Unix systems so far (MacOS, Ubuntu).
51+ Might work under Windows with a few modifications.
3952
4053### Create Virtual Machine
4154
4255```
4356git checkout git@github.com:marvel-nccr/quantum-mobile.git
4457cd quantum-mobile
4558pip install -r requirements.txt
59+ ansible-galaxy install -r requirements.yml
4660vagrant plugin install vagrant-vbguest # optional, improves interface
4761vagrant up # build vm from scratch (takes some tens of minutes)
4862```
4963
64+ Note: Due to a bug in the vbguest vagrant plugin, there are some additional steps #60
65+
5066### Create image
5167```
5268# optional: reduce size of VM
0 commit comments