Merge pull request #15 from fangohr/development

INF-010

Author: mvousden

Makefile

@@ -9,4 +9,9 @@ full:
 # This target builds a virtual hard disk file containing various open
 # micromagnetics simulation technologies.
 lite:
-	ansible-playbook master.yml -c local -i localhost, -v -k --extra-vars="vm_name=virtualmicromagnetics-lite playbook=provision_virtualmicromagnetics_lite.yml hookbook=hook.yml extra_resources_dir=guest_resources/"
+	ansible-playbook master.yml -c local -i localhost, -v -k --extra-vars="vm_name=virtualmicromagnetics-lite playbook=provision_virtualmicromagnetics_lite.yml hookbook=hook.yml extra_resources_dir=guest_resources/"
+
+# This target builds a virtual hard disk file containing a fidimag
+# installation.
+fidimag:
+	ansible-playbook master.yml -c local -i localhost, -v -k --extra-vars="vm_name=virtualmicromagnetics-fidimag playbook=provision_virtualmicromagnetics_fidimag.yml hookbook=hook.yml extra_resources_dir=guest_resources/"

guest_resources/vagrantfiles/Vagrantfile_virtualmicromagnetics-fidimag_builtin

@@ -0,0 +1,25 @@
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+# This vagrantfile is not to be used to create a virtual machine using this
+# repository. Instead, it is a vagrantfile that is to be embedded (built in) to
+# the box file created by 'make full'. For more information about built-in
+# vagrantfiles, see:
+#
+#   https://docs.vagrantup.com/v2/vagrantfile/index.html#load-order
+#
+# This particular vagrant file changes the user credentials that connects to
+# the Virtual Micromagnetics environment with, and enables a GUI by default.
+
+VAGRANTFILE_API_VERSION = "2"
+
+Vagrant.configure(VAGRANTFILE_API_VERSION) do |config|
+
+  config.vm.provider :virtualbox do |vb|
+    vb.gui = true
+  end
+
+  config.ssh.username = "virtualmicromagnetics"
+  config.ssh.password = "virtualmicromagnetics"
+
+end

jobs/provision_virtualmicromagnetics_fidimag.yml

@@ -0,0 +1,46 @@
+---
+# This Ansible playbook is a provision playbook designed to be used with
+# vagrant. This playbook provisions a machine suitable for micromagnetic
+# simulation, and includes other convenient softwares for such an
+# environment. It is executed by the virtual machine.
+
+- hosts: all
+
+# We install docutils here instead of using the role directly, so that the
+# welcome file can be created before the superuser is added.
+  pre_tasks:
+
+    - name: Install pip.
+      apt:
+        pkg=python-pip
+        state=latest
+        update_cache=yes
+        cache_valid_time=86400
+      sudo: yes
+
+    - name: Install docutils for Python to build documentation.
+      pip:
+        name=docutils
+      sudo: yes
+
+    - name: Define directory in which to place welcome file.
+      set_fact:
+        WELCOME_DIR: /etc/skel/Desktop
+
+    - name: Create welcome directory.
+      file:
+        name={{ WELCOME_DIR }}
+        state=directory
+      sudo: yes
+
+    - name: Convert documentation to HTML and place in welcome directory.
+      shell: rst2html.py /vagrant/extra_resources/welcome.rst Welcome.html
+        chdir={{ WELCOME_DIR }}
+        creates={{ WELCOME_DIR }}/Welcome.html
+      sudo: yes
+
+  roles:
+    - fidimag
+    - xserver
+    - { role: add_super_user, AUTOLOGIN: true }
+    - { role: set_hostname, HOSTNAME: virtualmicromagnetics-fidimag }

jobs/provision_virtualmicromagnetics_full.yml

@@ -47,6 +47,7 @@
     - magpar_examples
     - nmag
     - nmag_examples
+    - fidimag
     - xserver
     - { role: add_super_user, AUTOLOGIN: true }
     - { role: set_hostname, HOSTNAME: virtualmicromagnetics-full }

jobs/provision_virtualmicromagnetics_lite.yml

@@ -45,6 +45,7 @@
     - magpar_examples
     - nmag
     - nmag_examples
+    - fidimag
     - xserver
     - { role: add_super_user, AUTOLOGIN: true }
     - { role: set_hostname, HOSTNAME: virtualmicromagnetics-lite }

roles/fidimag/tasks/clone_fidimag_version.yml

@@ -0,0 +1,20 @@
+---
+# This Ansible include-playbook clones Fidimag source.
+
+- name: Ensure that Git and openssh-client are installed.
+  apt:
+    pkg: "{{ item }}"
+    state: latest
+    update_cache: yes
+    cache_valid_time: 86400
+  with_items:
+    - git
+    - openssh-client
+  sudo: yes
+
+- name: Clone the Fidimag source.
+  git:
+    repo: "{{ FIDIMAG_REPO_URL }}"
+    dest: "{{ FIDIMAG_INSTALL_PATH }}"
+    version: "{{ FIDIMAG_VERSION }}"
+  sudo: yes

roles/fidimag/tasks/install_dependencies_from_packages.yml

@@ -0,0 +1,27 @@
+---
+# This Ansible include-playbook installs Fidimag dependencies from packages.
+
+- name: Install dependencies in Ubuntu packages.
+  apt:
+    pkg: "{{ item }}"
+    state: latest
+    update_cache: yes
+    cache_valid_time: 86400
+  with_items:
+    - gcc
+    - ipython
+    - mayavi2
+    - python-dev
+    - python-matplotlib
+    - python-numpy
+    - python-pip
+    - python-pytest
+    - python-pyvtk
+    - python-scipy
+  sudo: yes
+
+- name: Install dependencies with Pip.
+  pip:
+    name: cython
+    extra_args: --upgrade
+  sudo: yes

roles/fidimag/tasks/main.yml

@@ -0,0 +1,7 @@
+---
+# This Ansible role installs Fidimag on the virtual machine.
+
+- include: clone_fidimag_version.yml
+- include: install_dependencies_from_packages.yml
+- include: make_fidimag.yml
+- include: set_paths.yml

roles/fidimag/tasks/make_fidimag.yml

@@ -0,0 +1,18 @@
+---
+# This Ansible playbook build Fidimag from scripts in the Fidimag
+# repository. This include installing local dependencies including FFTW and
+# SUNDIALS.
+
+# Install local dependencies.
+- name: Install FFTW and SUNDIALS from the Fidimag installation script.
+  command: bash install.sh
+  args:
+    chdir: "{{ FIDIMAG_INSTALL_PATH }}/bin"
+  sudo: yes
+
+# Build Fidimag. Makefile module?
+- name: Build Fidimag.
+  command: make
+  args:
+    chdir: "{{ FIDIMAG_INSTALL_PATH }}"
+  sudo: yes

roles/fidimag/tasks/set_paths.yml

@@ -0,0 +1,19 @@
+---
+# This Ansible include-playbook sets envionment variables which denote
+# essential paths for Fidimag.
+
+- name: Add Fidimag to PYTHONPATH.
+  lineinfile:
+    dest: /etc/profile.d/fidimag.sh
+    regexp: "^export PYTHONPATH="
+    line: "export PYTHONPATH=\"{{ FIDIMAG_INSTALL_PATH }}/:$PYTHONPATH\""
+    create: yes
+  sudo: yes
+
+- name: Add Fidimag library path to LD_LIBRARY_PATH.
+  lineinfile:
+    dest: /etc/profile.d/fidimag.sh
+    regexp: "^export LD_LIBRARY_PATH="
+    line: "export LD_LIBRARY_PATH=\"{{ FIDIMAG_INSTALL_PATH }}/local/lib:$LD_LIBRARY_PATH\""
+    create: yes
+  sudo: yes