Installing DiViMe


DiViMe can be installed in any operating system and computer with at least 2 CPUs, 8GB of RAM, and 25GB of available disc space. You may need more of everything to actually use the tools, specifically when running on large files. Before following the instructions under “First Installation”, you must follow the instructions in the relevant subsection of the Troubleshooting section, at the end of this page, in the following cases:

  • your computer has only one core (or you don’t know)
  • your computer has 25 GB or less of disc space
  • your computer has 6 GB or less of RAM
  • your computer is running Ubuntu (e.g., 16.04)

First Installation

  1. Install Vagrant: Click on the download link for your operating system and follow the prompted instructions
  2. Install VirtualBox: When we last checked, the links for download for all operating systems were under the header “VirtualBox 5.2.18 platform packages”, so look for a title like that one (picking the latest version, most likely).
  3. Clone the present repository: To do this, you must use a terminal. If you don’t know what this means, we recommend that you first follow the Software Carpentry Shell Tutorial (up to 00:45, namely “Introducing the shell”, and “Navigating files and directories”). Next, navigate to the directory in which you want the VM to be hosted and type in: $ git clone - or use another way or tool to “clone” a Git repository
  4. Change into this folder: $ cd DiViMe
  5. Install several Vagrant plugins: $ vagrant plugin install vagrant-aws vagrant-sshfs vagrant-vbguest

Depending on how you want to use DiViMe, and which provider you will be using, you may or may not need to install the above plugins (or you may need to install additional plugins), but this quickly turns into an advanced topic, because not all plugins will work equally well on all host platforms …

  1. Type $ vagrant up

The first time you do this, it will take at least 15 minutes to install all the packages that are needed to build the virtual machine. You are done when you see something like this:

FloriansMBP2019:DiViMe metze$ tail -n 8 example-logs/vagrant-up.log 
    default: build succeeded, 4 warnings.
    default: The HTML pages are in build/html.
    default: INFO: You can remove, if you don't plan on re-provisioning DiViMe any time soon.
    default: INFO: You can remove, if you don't plan on re-provisioning DiViMe any time soon.
    default: ---- Done bootstrapping DiViMe @ Wed Jul  3 03:30:01 UTC 2019 ----
    default: root@vagrant-ubuntu-trusty-64:/home/vagrant# 
    default: exit

The instructions above make the simplest assumptions as to your environment. If you have Amazon Web Services, an Ubuntu system, or you do not have admin rights in your computer, you might need to read the instructions to the eesen-transcriber for fancier options. Or you can just open an issue here, describing your situation.

We are working on Installing With Docker, but this option is not yet fully functional.

Please note that there is a large amount of documentation on Vagrant and Virtualbox online, explaining on how to fix assorted errors. It is often a good idea to simply “google” errors that these tools throw; you may find a solution to your specific problem quickly, because the problem may not lie with DiViMe, but the VM, before DiViMe gets involved.

Checking your installation

The very first time you use DiViMe, it is a good idea to run a quick start test, which will be performed using data from the VanDam Public Daylong HomeBank corpus (VanDam et al., 2015):

  1. Open a terminal
  2. Navigate inside the DiViMe folder
  3. Do $ vagrant up (if you haven’t done it already)
  4. Do $ vagrant ssh -c "launcher/"

This should produce the following output:

FloriansMBP2019:DiViMe metze$ vagrant ssh -c "launcher/"
Starting tests
Checking for HTK...
   HTK missing. You can probably ignore this warning, HTK is no longer needed.
Testing noisemes...
Noisemes passed the test.
Testing OpenSmile SAD...
OpenSmile SAD passed the test.
Congratulations, everything is OK! 

When you are done with DiViMe, Teardown

After working with DiViMe, you can shut down the virtual machine, which will free up CPU and RAM resources on your computer (but not disc space). To do this, type $ vagrant halt or $ vagrant suspend. To continue working with the VM at a later point, simply issue another $ vagrant up command.

Updating DiViMe

If you want to install a new release of DiViMe, you will need to perform the following 3 steps from within the DiViME folder on your terminal:

$ vagrant destroy
$ git pull
$ vagrant up


If you want to get rid of the files completely, you should perform the following 3 steps from within the DiViME folder on your terminal (assuming you are on Unix):

$ vagrant destroy
$ cd ..
$ rm -rf DiViMe


If your computer only has one core

Before doing vagrant up, open the file called DiViMe/Vagrantfile in a text editor. Change the following line:

> vbox.cpus = 2


> vbox.cpus = 1

Then proceed with the installation. Also, if you have more than one CPU, and you do not want DiViMe to take over your entire computer, you can set it to any value >= 2, and you should be fine. DiViMe uses multiple processors, but we have not yet fully optimized for many cores.

If your computer has 25 GB or less of storage space

If your computer has less than 25 GB of storage space, then you cannot build a fully working DiViMe. In this case, clean up your files to free up space.

If your computer has 6 GB or less of RAM

If your computer has less than about 8 GB of RAM, then you may or may not be able to build and use DiViMe. You probably need to change the space allocated to the virtual machine. Before doing vagrant up, open the file called DiViMe/Vagrantfile in a text editor. Change the following line:

> vbox.memory = 4096


> vbox.memory = 2048

Then proceed with the Installation. Also, if you have more RAM, and you experience issues during installation (or use), you may benefit from increasing this value, which should normally not exceed half of your total installed RAM (as a rule of thumb).

If your computer is running Ubuntu (16.04)

There is a known incompatibility between VirtualBox and the 4.13 Linux kernel on Ubuntu 16.04. What you may do is to install a previous version of the kernel, for example the 4.10, following these instructions, or install the latest version of VirtualBox, which should fix the problem.

Again, there is often a lot of information available online, because Vagrant and VirtualBox are widely used tools.

If something else fails

Please open an issue here. Please paste the complete output of the failing run there, so we can better provide you with a solution. Also, please provide detailed information on your host system (which OS, RAM, CPU, HDD), which changes you made to the Vagrantfile, and also provide access to the data the system chokes on (if any).


VanDam, M., De Palma, P., Strong, W. E. (2015, May). Fundamental frequency of speech directed to children who have hearing loss. Poster presented at the 169th Meeting of the Acoustical Society of America, Pittsburgh, PA.