################################################################################
# Developers
################################################################################
The Vagrant file and ansible playbook have been developed by Carlo Scanelli and
Joshua Brown. If you have questions or suggestion feel free to contact me at. 

[email protected]

################################################################################
# Purpose
################################################################################
This repo contains a Vagrant file for easily bringing up a virtual machine 
specifically for developing the VOTCA source code. It should work with out 
problems on any host operating system. In the case that the development 
environment becomes corrupt Vagrant provides an easy means to destroy the 
corrupt virtual machine and start from scratch without the hassle of detailed 
and custom installation procedures (they are automated). 

################################################################################
# What is included
################################################################################
The vagrant file will automatically setup a CentOS operating system with gui. 
It is set to use 4GB of ram and 2 CPUs. Once it is finished setting up these 
settings can be adjusted as needed through the VirtualBox user interface. 

################################################################################
# Installation
################################################################################
Step 1 To quickly get started you will need the following installed on your 
host operating system:

  o Oracles VirtualBox 5.1.30
  o Vagrant

You should follow the instructions for installing each package according to 
your host operating system. 

NOTE: If you have Windows 10 it is not recommended to attempt to install Vagrant
or Virtualbox on the bash linux subsystem as the linux subsystem at this point 
is not setup to work well with a graphical user interface. 

Step 2 Once vagrant has been installed, you will also need the guest ansible 
plugin. It is very straightforward to install:

$ vagrant plugin install vagrant-guest_ansible

################################################################################
# Running Vagrant
################################################################################
To get the development enviornment up and running you simply have to type:

$ vagrant up

This will take a while. After it is finished you will have a fully functioning 
VM with the latest pull from VOTCAs git repo. It might be necessary to restart
the VM before the resolution from the guest additions will start to work. To do
this you can simply type:

$ vagrant reload

To shut the VM down 

$ vagrant halt

Finally, if you desire to return the VM to original state you can reprovision 
it. Note, that if you do this the provisioning step may overwrite your work. 

$ vagrant provision

In the case that you have seriously brocken your virtual machine and wish to 
start from scratch, there is an easy way to do this. You will first destroy the
virtual machine, and then call up. 

$ vagrant destroy

$ vagrant up

WARNING this will start you with a clean slate everything that was on the 
virtual machine will be destroyed so be sure to save the files you want to keep.

################################################################################
# Loggin in
################################################################################
To log in you can use:
user name: vagrant
password: vagrant

The VOTCA source code is the /home/vagrant/Desktop directory. Happy developing!