Merge pull request #37 from computationalmodelling/DOC-034

DOC-034: Minor Documentation Repairs.

Author: mvousden

docs/developer-notes.rst

@@ -247,5 +247,5 @@ virtual machines can be parameterised.
 Thank you for using Virtual Micromagnetics! If you create roles for your
 favourite software, consider sharing them with the community. You can create a
 pull request at our GitHub repository at
-(https://github.com/fangohr/virtualmicromagnetics), or contacting Mark at
-mark[dot]vousden[at]soton[dot]ac[dot]uk.
+https://github.com/computationalmodelling/virtualmicromagnetics, or
+contacting Mark at mark[dot]vousden[at]soton[dot]ac[dot]uk.

docs/getting-started-poweruser.rst

@@ -21,8 +21,9 @@ With this software:
 
 1. Grab a copy of Virtual Micromagnetics. You can do this via Git by cloning
    our repository with ``git clone -b release
-   https://github.com/fangohr/virtualmicromagnetics.git``, or by grabbing a
-   release version at https://github.com/fangohr/virtualmicromagnetics/releases
+   https://github.com/computationalmodelling/virtualmicromagnetics.git``, or by
+   grabbing a release version at
+   https://github.com/computationalmodelling/virtualmicromagnetics/releases
 
 2. Install some sub-packages:
 

docs/graphs/graph.py

@@ -32,7 +32,7 @@
 userMach = "User's Virtual\nMachine"
 userGraph.node(outputEnv, **envNodeProps)
 userGraph.node(userMach, **machNodeProps)
-userGraph.edge(outputEnv, userMach, "Vagrant and\nVirtualBox Creates",
+userGraph.edge(outputEnv, userMach, "Vagrant and\nVirtualBox creates",
                {"color": "blue", "fontname": font})
 
 # Create developer graph.
@@ -45,11 +45,11 @@
 devGraph.node(outputEnv, **envNodeProps)
 devGraph.node(inputEnv, **envNodeProps)
 devGraph.node(devMach, **machNodeProps)
-devGraph.edge(inputEnv, devMach, "Vagrant and\nVirtualBox Creates",
+devGraph.edge(inputEnv, devMach, "Vagrant and\nVirtualBox creates",
               {"color": vboxVagrant, "fontname": font, "rank": "same"})
-devGraph.edge(devMach, devMach, "Ansible\nProvisions",
+devGraph.edge(devMach, devMach, "Ansible\nprovisions",
               {"color": ansible, "fontname": font})
-devGraph.edge(devMach, outputEnv, "Vagrant\nPackages",
+devGraph.edge(devMach, outputEnv, "Vagrant\npackages",
               {"color": vagrant, "fontname": font})
 
 # Combine and print graphs.

docs/images/graph.png

@@ -4,11 +4,16 @@ Virtual Micromagnetics Documentation
 .. image:: images/virtual_micromagnetics_logo.png
    :scale: 50%
    :align: right
-   :target: http://fangohr.github.io/virtualmicromagnetics/
+   :target: http://virtualmicromagnetics.org
 
 Welcome to the :term:`Virtual Micromagnetics` project, where we aim to enable
 accessible and reproducible micromagnetics simulation, without compromise.
 
+Provided by Mark Vousden, Hans Fangohr, and others at the University of
+Southampton. Funded by EPSRC's DTC grant EP/G03690X/1. The license for this
+software is available `here
+<https://github.com/computationalmodelling/virtualmicromagnetics/blob/development/LICENSE.md>`_.
+
 The :term:`Virtual Micromagnetics` project creates :term:`virtual
 environment`\s that run micromagnetic (and in some cases, atomistic)
 simulations of magnetic behaviour. These environments produce :term:`system

docs/index.rst

@@ -5,6 +5,6 @@ Troubleshooting
 
 Currently there is not troubleshooting information for Virtual
 Micromagnetics. If you have an issue, please add it to our issue tracker at
-https://github.com/fangohr/virtualmicromagnetics/issues, or email
-mark[dot]vousden[at]soton[dot]ac[dot]uk. We will endeavour to resolve the issue
-and add it here if it is widespread.
+https://github.com/computationalmodelling/virtualmicromagnetics/issues, or
+email mark[dot]vousden[at]soton[dot]ac[dot]uk. We will endeavour to resolve the
+issue and add it here if it is widespread.

docs/troubleshooting.rst

@@ -23,8 +23,8 @@ single files representing the equivalent of a hard disk of the machine, as well
 as a description of the hardware that the virtual machine emulates. This makes
 them simple to distribute.
 
-Virtual Machine Software
-------------------------
+Software Related to Virtual Machines
+------------------------------------
 
 Virtual machines must be supported by software in order to function. Only
 provider software is necessary to run a virtual machine, but managers and
@@ -52,14 +52,14 @@ Managers
 
 While not essential for starting :term:`virtual machine`\s, specialist software
 is useful for managing :term:`virtual environment`\s. Vagrant
-(www.vagrantup.com) is an example of a virtual machine manager. It provides a
-command-line interface to the creation and provision of virtual machines from
-virtual environments. HashiCorp, the company behind Vagrant, also provides a
-framework for sharing virtual environments. Most importantly for our purpose,
-Vagrant can be automated to generate virtual machines containing an environment
-without user intervention. This environment can then be used to complete our
-objectives. To specify this environment however, provisioning software is
-required.
+(https://www.vagrantup.com) is an example of a virtual machine manager. It
+provides a command-line interface to the creation and provision of virtual
+machines from virtual environments. HashiCorp, the company behind Vagrant, also
+provides a framework for sharing virtual environments. Most importantly for our
+purpose, Vagrant can be automated to generate virtual machines containing an
+environment without user intervention. This environment can then be used to
+complete our objectives. To specify this environment however, provisioning
+software is required.
 
 .. _software-provisioners:
 
@@ -73,10 +73,11 @@ provisioner describes the desired state of the system, and the provisioner
 makes it so. In the absence of a provisioner, shell commands can be executed to
 specify the state, but this becomes unwieldy for large projects because focus
 is placed on the instructions needed to obtain the desired state, as opposed to
-the state itself. Provisioning software, such as Ansible (www.ansible.com)
-alleviates this problem. Ansible uses Yet Another Markup Language (YAML) to
-describe plays to run on a machine to enact the desired end state. Since the
-focus is on the end state of the system, :term:`idempotency` is essential.
+the state itself. Provisioning software, such as Ansible
+(https://www.ansible.com) alleviates this problem. Ansible uses Yet Another
+Markup Language (YAML) to describe plays to run on a machine to enact the
+desired end state. Since the focus is on the end state of the system,
+:term:`idempotency` is essential.
 
 .. _software-summary: