Merge pull request #24 from fangohr/pkg-011

Pkg 011

Author: mvousden

guest_resources/fidimag_examples.rst

@@ -0,0 +1,13 @@
+Fidimag Examples
+----------------
+
+Fidimag example files can be found locally in::
+
+    `~/fidimag-examples`
+
+A test suite is also available, and can be used by commanding::
+
+    sudo su  # We need to run this as root for permissions purposes.
+    cd /opt/fidimag
+    make test
+    exit

guest_resources/nmag_examples.rst

@@ -1,5 +1,5 @@
 Nmag Examples
---------
+-------------
 
 Nmag examples can also be run, and can be found in section 2 (Guided Tour) of
 the manual found here:

jobs/provision_virtualmicromagnetics_fidimag.yml

@@ -10,6 +10,7 @@
 
   roles:
     - fidimag
+    - fidimag_examples
     - xserver
     - { role: rst_to_html, SOURCE_PATH: "/vagrant/extra_resources/welcome/welcome_{{ vm_name }}.rst" }
     - add_super_user

jobs/provision_virtualmicromagnetics_full.yml

@@ -18,6 +18,7 @@
     - nmag
     - nmag_examples
     - fidimag
+    - fidimag_examples
     - xserver
     - { role: rst_to_html, SOURCE_PATH: "/vagrant/extra_resources/welcome/welcome_{{ vm_name }}.rst" }
     - add_super_user

jobs/provision_virtualmicromagnetics_lite.yml

@@ -16,6 +16,7 @@
     - nmag
     - nmag_examples
     - fidimag
+    - fidimag_examples
     - xserver
     - { role: rst_to_html, SOURCE_PATH: "/vagrant/extra_resources/welcome/welcome_{{ vm_name }}.rst" }
     - add_super_user

roles/fidimag_examples/meta/main.yml

@@ -0,0 +1,4 @@
+---
+dependencies:
+  - { role: fidimag }
+  - { role: rst_to_html, BUILD_DIR: "{{ EXAMPLES_DOC_FOLDER }}", SOURCE_PATH: "{{ EXAMPLES_RST_FILE }}", BUILD_NAME: "{{ EXAMPLES_OUTPUT_NAME }}" }

roles/fidimag_examples/tasks/main.yml

@@ -0,0 +1,11 @@
+---
+# This Ansible role prepares Fidimag examples and places some documentation on
+# the Desktop.
+
+# This task is not very robust, but I can't think of a better way of doing
+# this.
+
+- name: Copy fidimag examples to a more accessible location.
+  command: cp -r /opt/fidimag/examples {{ FIDIMAG_EXAMPLES_FOLDER }}
+    creates={{ FIDIMAG_EXAMPLES_FOLDER }}
+  sudo: yes

roles/fidimag_examples/vars/main.yml

@@ -0,0 +1,10 @@
+# Examples location
+EXAMPLES_FOLDER: /etc/skel
+FIDIMAG_EXAMPLES_FOLDER: "{{ EXAMPLES_FOLDER }}/fidimag-examples"
+
+# Path of the RST template to generate HTML examples from.
+EXAMPLES_RST_FILE: /vagrant/extra_resources/fidimag_examples.rst
+EXAMPLES_OUTPUT_NAME: Fidimag_examples.html
+
+# Location to place the HTML documentation.
+EXAMPLES_DOC_FOLDER: "{{ EXAMPLES_FOLDER }}/Desktop"