Skip to content

Latest commit

 

History

History
252 lines (168 loc) · 5.39 KB

README.md

File metadata and controls

252 lines (168 loc) · 5.39 KB
Raw

aeneas-vagrant

aeneas-vagrant automates the creation of a Vagrant box to run aeneas

Goal

aeneas is a Python/C library and a set of tools to automagically synchronize audio and text (aka forced alignment). See the aeneas documentation for further details.

This repo contains the files needed to automate the creation of a Vagrant box to run aeneas inside VirtualBox.

System Requirements, Supported Platforms and Installation

System Requirements

  1. 2 GB RAM, 2 GHz CPU (4 GB RAM, 3 GHz CPU recommended)
  2. VirtualBox
  3. Vagrant

Supported Platforms

Any host platform supported by VirtualBox and Vagrant.

This Vagrant box has been tested under Linux (Debian) and Mac OS X, but it should work on Windows too.

Installation

Make sure you have VirtualBox and Vagrant installed on your machine, and 3.5 GB of free space.

git clone https://github.com/readbeyond/aeneas-vagrant.git
cd aeneas-vagrant

The default configuration (file Vagrantfile) creates a VirtualBox machine with 2 GB of RAM:

vb.memory = "2048"

You might want to set a larger value if you have more RAM on your host machine, for example 4096 if you have more than 4 GB of RAM.

To start the initialization of the Vagrant box, just run:

vagrant up

Vagrant will download a base box and then it will run the setup.sh provisioning script to install all the executables, Python modules, and source code needed to run aeneas.

This one-time process might take between 5 and 30 minutes, depending on the bandwidth of your network connection and processor clock, and it will download roughly 1 GB of data, creating a VirtualBox image of roughly 3.5 GB on your host machine disk.

Usage

Starting the box

  1. Start the box:

    vagrant up

  2. Log into the box:

    vagrant ssh

  3. You will get a new prompt:

    vagrant@debian-jessie:~$

Running aeneas

At this point you can run aeneas as if it was installed on your host machine. For example:

vagrant@debian-jessie:~$ python -m aeneas.tools.execute_job -h

will show the usage message for execute_job.

You can also use the aeneas_execute_job shortcut:

vagrant@debian-jessie:~$ aeneas_execute_job -h

If you want to run the sample job:

vagrant@debian-jessie:~$ aeneas_execute_job ../../usr/local/lib/python2.7/dist-packages/aeneas/tools/res/job.zip /vagrant/

will execute the sample job and place its output in the /vagrant/ shared directory.

The /vagrant/ directory is shared between the host machine (usually your PC) and the guest machine (the virtual box); you can use it to read your input materials and to write the files output by aeneas. For example, you can read job.zip from your host machine and write its output to your host machine:

vagrant@debian-jessie:~$ aeneas_execute_job /vagrant/job.zip /vagrant/

Similarily, you can use the following shortcuts:

  • aeneas_check_setup
  • aeneas_convert_syncmap
  • aeneas_download
  • aeneas_execute_job
  • aeneas_execute_task
  • aeneas_plot_waveform
  • aeneas_synthesize_text
  • aeneas_validate

Run any of them with the -h or --help flag to print its usage message.

Suspending, closing and destroying the box

To suspend the box:

vagrant@debian-jessie:~$ exit
vagrant suspend

To shut the box down:

vagrant@debian-jessie:~$ exit
vagrant halt

You can resume from suspended or halted state by:

vagrant up

If you want to destroy the box, deleting the VirtualBox machine files:

vagrant destroy

(The destroy command cannot be undone! You will need to recreate the box from scratch to work with aeneas another time. Use it only if you are sure you want to delete the virtual box.)

Updating aeneas

If you want to update aeneas inside the Vagrant box (e.g., because a new version has been released):

  1. Start the box:

    vagrant up

  2. Log into the box:

    vagrant ssh

  3. Update aeneas via pip:

    sudo pip install aeneas --upgrade

Issues

Shared Folder Not Working in Ubuntu

Reported by [David].

On Ubuntu 16.04 using Vagrant 1.8.1, folder syncing was not working. I added the following lines to Vagrantfile:

config.vm.network "private_network", ip: "192.168.33.10"
config.vm.synced_folder ".", "/vagrant", type: "nfs"

I also needed to install and reload:

sudo apt-get install nfs-kernel-server
vagrant reload

Then the shared folder worked.

aeneas Commands Not Available

Reported by [David].

When I set up the VM on Ubuntu 16.04, I noticed the aeneas_* commands were not available on the terminal until I ran (inside the VM):

sudo pip install aeneas --upgrade

License

aeneas-vagrant is released under the terms of the GNU Affero General Public License Version 3. See the LICENSE file for details.

Acknowledgments

Daniel Bair helped improving the setup script.