Skip to content

Commit 8313a25

Browse files
committed
Merge pull request #22 from fangohr/feat-013
Feat 013
2 parents a0f0d4a + ad58c56 commit 8313a25

13 files changed

+143
-20
lines changed
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
Welcome to the Fidimag Virtual Micromagnetics Simulation Environment!
2+
---------------------------------------------------------------------
3+
4+
This virtual machine contains a lightweight installation of the Fidimag
5+
software for simulation use, specifically:
6+
7+
| Fidimag 1.0 (Finite-difference Micromagnetic and Atomistic Package): http://computationalmodelling.github.io/fidimag/
8+
| Documentation: http://fidimag.readthedocs.org/en/latest/
9+
10+
Documented examples are also available on the desktop.
11+
12+
This tool is provided by the University of Southampton (Mark Vousden, Max
13+
Albert, Hans Fangohr and others). Neither the University of Southampton nor the
14+
authors assume any responsibility whatsoever for its use by other parties, and
15+
makes no guarantees, expressed or implied, about its quality, reliability, or
16+
any other characteristic. Please provide feedback about this machine to Mark
17+

guest_resources/welcome.rst renamed to guest_resources/welcome/welcome_virtualmicromagnetics-full.rst

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
Welcome to the Virtual Micromagnetics Simulation Environment!
2-
-------------------------------------------------------------
1+
Welcome to the Full Virtual Micromagnetics Simulation Environment!
2+
------------------------------------------------------------------
33

44
This virtual machine contains a number of distributable software packages that
55
are often used by the micromagnetic community to simulate relevant
@@ -13,13 +13,16 @@ particular order):
1313
| Nmag 0.2: http://nmag.soton.ac.uk/nmag/
1414
| Documentation: http://nmag.soton.ac.uk/nmag/current/manual/singlehtml/manual.html
1515
16-
| magpar 0.9 (Parallel Finite Element Micromagnetics Package): http://www.magpar.net/
16+
| Magpar 0.9 (Parallel Finite Element Micromagnetics Package): http://www.magpar.net/
1717
| Documentation: http://www.magpar.net/static/magpar-0.9/doc/html/
1818
19+
| Fidimag 1.0 (Finite-difference Micromagnetic and Atomistic Package): http://computationalmodelling.github.io/fidimag/
20+
| Documentation: http://fidimag.readthedocs.org/en/latest/
21+
1922
For more information about these packages, see their respective websites and
20-
`Examples.html <Examples.html>`_, which walks the prospective user through some
21-
examples and tests where applicable. Users are also encouraged to install their
22-
own simulation packages for use on this machine. To that end, a number of other
23+
examples available on the desktop, which walk the user through some examples
24+
and tests where applicable. Users are also encouraged to install their own
25+
simulation packages for use on this machine. To that end, a number of other
2326
software packages have been provided:
2427

2528
| FEniCS 1.5.0: http://fenicsproject.org/
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
Welcome to the Lite Virtual Micromagnetics Simulation Environment!
2+
------------------------------------------------------------------
3+
4+
This virtual machine contains a number of distributable software packages that
5+
are often used by the micromagnetic community to simulate relevant
6+
problems. These software can be downloaded from this machine; tarballs are
7+
available in the home directory. Micromagnetic software includes (in no
8+
particular order):
9+
10+
| OOMMF 1.2a5 (The Object Oriented MicroMagnetic Framework): http://math.nist.gov/oommf/
11+
| Documentation: http://math.nist.gov/oommf/doc/
12+
13+
| Nmag 0.2: http://nmag.soton.ac.uk/nmag/
14+
| Documentation: http://nmag.soton.ac.uk/nmag/current/manual/singlehtml/manual.html
15+
16+
| Magpar 0.9 (Parallel Finite Element Micromagnetics Package): http://www.magpar.net/
17+
| Documentation: http://www.magpar.net/static/magpar-0.9/doc/html/
18+
19+
| Fidimag 1.0 (Finite-difference Micromagnetic and Atomistic Package): http://computationalmodelling.github.io/fidimag/
20+
| Documentation: http://fidimag.readthedocs.org/en/latest/
21+
22+
For more information about these packages, see their respective websites and
23+
examples available on the desktop, which walk the user through some examples
24+
and tests where applicable.
25+
26+
These tools are provided by the University of Southampton (Mark Vousden, Max
27+
Albert, Hans Fangohr and others). Neither the University of Southampton nor the
28+
authors assume any responsibility whatsoever for its use by other parties, and
29+
makes no guarantees, expressed or implied, about its quality, reliability, or
30+
any other characteristic. Please provide feedback about this machine to Mark
31+
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
Welcome to the Magpar Virtual Micromagnetics Simulation Environment!
2+
--------------------------------------------------------------------
3+
4+
This virtual machine contains a lightweight installation of the Magpar
5+
software for simulation use, specifically:
6+
7+
| Magpar 0.9 (Parallel Finite Element Micromagnetics Package): http://www.magpar.net/
8+
| Documentation: http://www.magpar.net/static/magpar-0.9/doc/html/
9+
10+
Documented examples are also available on the desktop.
11+
12+
This tool is provided by the University of Southampton (Mark Vousden, Max
13+
Albert, Hans Fangohr and others). Neither the University of Southampton nor the
14+
authors assume any responsibility whatsoever for its use by other parties, and
15+
makes no guarantees, expressed or implied, about its quality, reliability, or
16+
any other characteristic. Please provide feedback about this machine to Mark
17+
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
Welcome to the Nmag Virtual Micromagnetics Simulation Environment!
2+
------------------------------------------------------------------
3+
4+
This virtual machine contains a lightweight installation of the Nmag software
5+
for simulation use, specifically:
6+
7+
| Nmag 0.2: http://nmag.soton.ac.uk/nmag/
8+
| Documentation: http://nmag.soton.ac.uk/nmag/current/manual/singlehtml/manual.html
9+
10+
Documented examples are also available on the desktop.
11+
12+
This tool is provided by the University of Southampton (Mark Vousden, Max
13+
Albert, Hans Fangohr and others). Neither the University of Southampton nor the
14+
authors assume any responsibility whatsoever for its use by other parties, and
15+
makes no guarantees, expressed or implied, about its quality, reliability, or
16+
any other characteristic. Please provide feedback about this machine to Mark
17+
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
Welcome to the OOMMF Virtual Micromagnetics Simulation Environment!
2+
-------------------------------------------------------------------
3+
4+
This virtual machine contains a lightweight installation of the OOMMF
5+
software for simulation use, specifically:
6+
7+
| OOMMF 1.2a5 (The Object Oriented MicroMagnetic Framework): http://math.nist.gov/oommf/
8+
| Documentation: http://math.nist.gov/oommf/doc/
9+
10+
Documented examples are also available on the desktop.
11+
12+
This tool is provided by the University of Southampton (Mark Vousden, Max
13+
Albert, Hans Fangohr and others). Neither the University of Southampton nor the
14+
authors assume any responsibility whatsoever for its use by other parties, and
15+
makes no guarantees, expressed or implied, about its quality, reliability, or
16+
any other characteristic. Please provide feedback about this machine to Mark
17+

jobs/provision_virtualmicromagnetics_fidimag.yml

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,12 @@
55

66
- hosts: all
77

8+
vars:
9+
vm_name: virtualmicromagnetics-fidimag
10+
811
roles:
912
- fidimag
1013
- xserver
11-
- rst_to_html
14+
- { role: rst_to_html, SOURCE_PATH: "/vagrant/extra_resources/welcome/welcome_{{ vm_name }}.rst" }
1215
- add_super_user
13-
- { role: set_hostname, HOSTNAME: virtualmicromagnetics-fidimag }
16+
- { role: set_hostname, HOSTNAME: "{{ vm_name}}" }

jobs/provision_virtualmicromagnetics_full.yml

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@
66

77
- hosts: all
88

9+
vars:
10+
vm_name: virtualmicromagnetics-full
11+
912
roles:
1013
- other_dependencies
1114
- oommf
@@ -16,6 +19,6 @@
1619
- nmag_examples
1720
- fidimag
1821
- xserver
19-
- rst_to_html
22+
- { role: rst_to_html, SOURCE_PATH: "/vagrant/extra_resources/welcome/welcome_{{ vm_name }}.rst" }
2023
- add_super_user
21-
- { role: set_hostname, HOSTNAME: virtualmicromagnetics-full }
24+
- { role: set_hostname, HOSTNAME: "{{ vm_name}}" }

jobs/provision_virtualmicromagnetics_lite.yml

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@
55

66
- hosts: all
77

8+
vars:
9+
vm_name: virtualmicromagnetics-lite
10+
811
roles:
912
- oommf
1013
- oommf_examples
@@ -14,6 +17,6 @@
1417
- nmag_examples
1518
- fidimag
1619
- xserver
17-
- rst_to_html
20+
- { role: rst_to_html, SOURCE_PATH: "/vagrant/extra_resources/welcome/welcome_{{ vm_name }}.rst" }
1821
- add_super_user
19-
- { role: set_hostname, HOSTNAME: virtualmicromagnetics-lite }
22+
- { role: set_hostname, HOSTNAME: "{{ vm_name}}" }

jobs/provision_virtualmicromagnetics_magpar.yml

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,13 @@
55

66
- hosts: all
77

8+
vars:
9+
vm_name: virtualmicromagnetics-magpar
10+
811
roles:
912
- magpar
1013
- magpar_examples
1114
- xserver
12-
- rst_to_html
15+
- { role: rst_to_html, SOURCE_PATH: "/vagrant/extra_resources/welcome/welcome_{{ vm_name }}.rst" }
1316
- add_super_user
14-
- { role: set_hostname, HOSTNAME: virtualmicromagnetics-magpar }
17+
- { role: set_hostname, HOSTNAME: "{{ vm_name}}" }

0 commit comments

Comments
 (0)