Getting Started

With Vagrant (and VirtualBox)

The intended way to use the Virtual Micromagnetics environment is through Vagrant using VirtualBox as a provider (see About). Commanding the following in an empty directory with Vagrant and VirtualBox installed will download and run the lite Virtual Micromagnetics environment:

vagrant init virtualmicromagnetics/lite
vagrant up --provider virtualbox

The complete list of Virtual Micromagnetics environments can be found here. For example, to download and run the OOMMF Virtual Micromagnetics environment:

vagrant init virtualmicromagnetics/oommf
vagrant up --provider virtualbox

While you’re in the Virtual Micromagnetics environment, you’re active as a user with the following credentials:

  • User: virtualmicromagnetics
  • Password: virtualmicromagnetics

With Docker

Virtual Micromagnetics container environments also exist through Docker. Commanding this will download and run the lite Virtual Micromagnetics container environment in a terminal on your machine:

docker run -ti virtualmicromagnetics/lite:release /bin/bash -l

The complete list of Virtual Micromagnetics container environments can be found here. For example, to download and run the Nmag Virtual Micromagnetics container environment:

docker run -ti virtualmicromagnetics/nmag:release /bin/bash -l

Build your own!

Alternatively, you can create your own Virtual Micromagnetics environment with custom software. Check out the documentation at http://virtual-micromagnetics.readthedocs.io (Getting started as a Poweruser) for more information on how to do this.