|
1 | | -# Virtualmicromagnetics |
| 1 | +Welcome to the Virtual Micromagnetics project repository! |
2 | 2 |
|
3 | | -[](http://virtual-micromagnetics.readthedocs.org/en/latest/?badge=latest) |
4 | | - |
5 | | -## For users who want to run micromagnetic simulations |
6 | | - |
7 | | -This project provides a ready-built virtual machine to run micromagnetic simulations. The following open source software packages are provided |
8 | | - |
9 | | -* OOMMF 1.2a5 (The Object Oriented MicroMagnetic Framework): http://math.nist.gov/oommf/ |
10 | | - |
11 | | - Documentation: http://math.nist.gov/oommf/doc/ |
12 | | - |
13 | | -* Nmag 0.2.1: http://nmag.soton.ac.uk/nmag/ |
14 | | - |
15 | | - Documentation: http://nmag.soton.ac.uk/nmag/current/manual/singlehtml/manual.html |
16 | | - |
17 | | -* Magpar 0.9 (Parallel Finite Element Micromagnetics Package): http://www.magpar.net/ |
18 | | - |
19 | | - Documentation: http://www.magpar.net/static/magpar-0.9/doc/html/ |
20 | | - |
21 | | - |
22 | | -If you need to use one of these packages, and you prefer not to install them directly in your computer, you can |
23 | | - |
24 | | -1. Download the Virtualbox software: virtualbox is a program that allows running another (virtual) machine inside your real computer; the software pretends to be a real computer to the virtual machine operating system. For the real computer, which is generally called the 'host', virtualbox is just a program amongst many others. The virtual machine operating system and programs don't know they are executing in a virtual environment. |
25 | | - |
26 | | -2. Download the [virtualmicromagnetics disk image](https://www.dropbox.com/s/1wzqdh6j2iau50u/virtualmicromagnetics_full_9df447e4cc.zip?dl=0). Once done, you can create a virtual machine (see SECTION TO BE WRITTEN) from this disk image. |
27 | | - |
28 | | -3. Start the virtual machine, switch to full screen (if you like) and run your micromagnetic simulations in OOMMF, Magpar or Nmag in this virtual environment. |
29 | | - |
30 | | - |
31 | | -## For those who want to update/extend the automatic creation of this virtualbox |
32 | | - |
33 | | -Please read [docs/creating-virtual-machines.md](https://github.com/fangohr/virtualmicromagnetics/blob/master/creating-virtual-machines.md) |
34 | | - |
35 | | -## FAQ |
36 | | - |
37 | | -* Isn't a virtual machine slow when executing? |
38 | | - |
39 | | -Not necessarily - modern CPUs support virtualisation with high efficiency. |
40 | | - |
41 | | -* What operating system does the virtual machine run? |
42 | | - |
43 | | -We have chosen Ubuntu Linux here as research codes often install (only or) better on Linux based systems. |
44 | | - |
45 | | -* What does the virtual machine look like? |
46 | | - |
47 | | -[insert snapshopt of virtual machine in window in host OS Desktop], [insert snapshot of full screen session, showing OOMMF session with TkWindows, maybe] |
| 3 | +Check out our [](http://virtual-micromagnetics.readthedocs.org/en/latest/?badge=latest) |
| 5 | +for information on building and using virtual environments. |
0 commit comments