Skip to content

Commit 4435165

Browse files
committed
DOC-026: Add getting started text for users.
1 parent e64295b commit 4435165

File tree

1 file changed

+26
-2
lines changed

1 file changed

+26
-2
lines changed

docs/getting-started-user.rst

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,26 @@
1-
Getting Started
2-
===============
1+
Getting Started: As a User
2+
==========================
3+
4+
To start a :term:`Virtual Micromagnetics` environment, you will need the
5+
following software:
6+
7+
- VirtualBox >= 5.0 (https://www.virtualbox.org/wiki/downloads)
8+
9+
- Vagrant >= 1.7.4 (https://www.vagrantup.com/downloads)
10+
11+
Then command the following in an empty directory::
12+
13+
vagrant init virtualmicromagnetics/full
14+
vagrant up --provider virtualbox
15+
16+
These commands will download the Full Virtual Micromagnetics environment from
17+
the Internet to your computer, and load the environment automatically. When
18+
complete, you should be greeted with this window:
19+
20+
.. image:: images/user-window-1.png
21+
22+
This is output from a :term:`virtual machine` running on your computer! Virtual
23+
machines produced in this way run Ubuntu GNU/Linux (https://www.ubuntu.com)
24+
with the XFCE window manager. From here, follow instructions in the welcome
25+
file on the desktop to run simulations with the pre-installed packages. Never
26+
worry about software dependencies again!

0 commit comments

Comments
 (0)