{"id":15688034,"url":"https://github.com/readbeyond/aeneas-vagrant","last_synced_at":"2025-05-07T20:11:39.638Z","repository":{"id":33686803,"uuid":"37339578","full_name":"readbeyond/aeneas-vagrant","owner":"readbeyond","description":"aeneas-vagrant automates the creation of a Vagrant box to run aeneas","archived":false,"fork":false,"pushed_at":"2017-03-16T13:16:36.000Z","size":32,"stargazers_count":9,"open_issues_count":2,"forks_count":5,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-03-31T13:37:45.595Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/readbeyond.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-06-12T19:05:46.000Z","updated_at":"2024-10-27T16:10:52.000Z","dependencies_parsed_at":"2022-09-14T17:12:24.659Z","dependency_job_id":null,"html_url":"https://github.com/readbeyond/aeneas-vagrant","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/readbeyond%2Faeneas-vagrant","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/readbeyond%2Faeneas-vagrant/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/readbeyond%2Faeneas-vagrant/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/readbeyond%2Faeneas-vagrant/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/readbeyond","download_url":"https://codeload.github.com/readbeyond/aeneas-vagrant/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252949279,"owners_count":21830152,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-03T17:53:39.774Z","updated_at":"2025-05-07T20:11:39.619Z","avatar_url":"https://github.com/readbeyond.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# aeneas-vagrant\n\n**aeneas-vagrant** automates the creation of a Vagrant box to run **aeneas**\n\n* Version: 1.7.3\n* Date: 2017-03-15\n* Developed by: [Alberto Pettarin](http://www.albertopettarin.it/)\n* License: the GNU Affero General Public License Version 3 (AGPL v3)\n* Contact: [aeneas@readbeyond.it](mailto:aeneas@readbeyond.it)\n\n## Goal\n\n**aeneas** is a Python/C library and a set of tools to automagically synchronize audio and text (aka forced alignment).\nSee the [aeneas documentation](http://www.readbeyond.it/aeneas/) for further details.\n\nThis repo contains the files needed to automate\nthe creation of a [Vagrant box](https://www.vagrantup.com/)\nto run **aeneas** inside [VirtualBox](https://www.virtualbox.org/).\n\n\n## System Requirements, Supported Platforms and Installation\n\n### System Requirements\n\n1. 2 GB RAM, 2 GHz CPU (4 GB RAM, 3 GHz CPU recommended)\n2. [VirtualBox](http://www.virtualbox.org/)\n3. [Vagrant](http://www.vagrantup.com/)\n\n### Supported Platforms\n\nAny host platform supported by VirtualBox and Vagrant.\n\nThis Vagrant box has been tested under Linux (Debian) and Mac OS X,\nbut it should work on Windows too.\n\n### Installation\n\nMake sure you have VirtualBox and Vagrant installed on your machine,\nand 3.5 GB of free space.\n\n```bash\ngit clone https://github.com/readbeyond/aeneas-vagrant.git\ncd aeneas-vagrant\n```\n\nThe default configuration (file `Vagrantfile`)\ncreates a VirtualBox machine with 2 GB of RAM:\n\n```\nvb.memory = \"2048\"\n```\n\nYou might want to set a larger value if you have more RAM\non your host machine, for example `4096` if you have more than 4 GB of RAM.\n\nTo start the initialization of the Vagrant box, just run:\n\n```bash\nvagrant up\n```\n\nVagrant will download a base box and\nthen it will run the `setup.sh` provisioning script\nto install all the executables, Python modules,\nand source code needed to run **aeneas**.\n\nThis one-time process might take between 5 and 30 minutes,\ndepending on the bandwidth of your network connection\nand processor clock, and it will download roughly 1 GB of data,\ncreating a VirtualBox image of roughly 3.5 GB on your host machine disk.\n\n\n## Usage\n\n### Starting the box\n\n1. Start the box:\n\n    ```bash\n    vagrant up\n    ```\n\n2. Log into the box:\n\n    ```bash\n    vagrant ssh\n    ```\n\n3. You will get a new prompt:\n\n    ```bash\n    vagrant@debian-jessie:~$\n    ```\n\n\n### Running `aeneas`\n\nAt this point you can run **aeneas** as if it was installed\non your host machine. For example:\n\n```bash\nvagrant@debian-jessie:~$ python -m aeneas.tools.execute_job -h\n```\n\nwill show the usage message for `execute_job`.\n\nYou can also use the `aeneas_execute_job` shortcut:\n\n```bash\nvagrant@debian-jessie:~$ aeneas_execute_job -h\n```\n\nIf you want to run the sample job:\n\n```bash\nvagrant@debian-jessie:~$ aeneas_execute_job ../../usr/local/lib/python2.7/dist-packages/aeneas/tools/res/job.zip /vagrant/\n```\n\nwill execute the sample job and place its output\nin the `/vagrant/` shared directory.\n\nThe `/vagrant/` directory is shared between\nthe host machine (usually your PC) and the guest machine (the virtual box);\nyou can use it to read your input materials and\nto write the files output by **aeneas**.\nFor example, you can read `job.zip` from your host machine\nand write its output to your host machine:\n\n```bash\nvagrant@debian-jessie:~$ aeneas_execute_job /vagrant/job.zip /vagrant/\n```\n\nSimilarily, you can use the following shortcuts:\n\n* `aeneas_check_setup`\n* `aeneas_convert_syncmap`\n* `aeneas_download`\n* `aeneas_execute_job`\n* `aeneas_execute_task`\n* `aeneas_plot_waveform`\n* `aeneas_synthesize_text`\n* `aeneas_validate`\n\nRun any of them with the `-h` or `--help` flag\nto print its usage message.\n\n\n### Suspending, closing and destroying the box\n\nTo suspend the box:\n\n```bash\nvagrant@debian-jessie:~$ exit\nvagrant suspend\n```\n\nTo shut the box down:\n\n```bash\nvagrant@debian-jessie:~$ exit\nvagrant halt\n```\n\nYou can resume from suspended or halted state by:\n\n```bash\nvagrant up\n```\n\nIf you want to destroy the box,\ndeleting the VirtualBox machine files:\n\n```bash\nvagrant destroy\n```\n\n(The `destroy` command cannot be undone!\nYou will need to recreate the box from scratch\nto work with aeneas another time.\nUse it only if you are sure you want to delete\nthe virtual box.)\n\n### Updating `aeneas`\n\nIf you want to update `aeneas`\ninside the Vagrant box\n(e.g., because a new version has been released):\n\n1. Start the box:\n\n    ```bash\n    vagrant up\n    ```\n\n2. Log into the box:\n\n    ```bash\n    vagrant ssh\n    ```\n3. Update `aeneas` via `pip`:\n\n    ```bash\n    sudo pip install aeneas --upgrade\n    ```\n\n## Issues\n\n### Shared Folder Not Working in Ubuntu\n\nReported by [David].\n\nOn Ubuntu 16.04 using Vagrant 1.8.1, folder syncing was not working.\nI added the following lines to ``Vagrantfile``:\n\n```\nconfig.vm.network \"private_network\", ip: \"192.168.33.10\"\nconfig.vm.synced_folder \".\", \"/vagrant\", type: \"nfs\"\n```\n\nI also needed to install and reload:\n\n```\nsudo apt-get install nfs-kernel-server\nvagrant reload\n```\n\nThen the shared folder worked.\n\n### aeneas Commands Not Available\n\nReported by [David].\n\nWhen I set up the VM on Ubuntu 16.04, I noticed the ``aeneas_*`` commands\nwere not available on the terminal until I ran (inside the VM):\n\n```\nsudo pip install aeneas --upgrade\n```\n\n\n## License\n\n**aeneas-vagrant** is released under the terms of the\nGNU Affero General Public License Version 3.\nSee the [LICENSE](LICENSE) file for details.\n\n## Acknowledgments\n\n[Daniel Bair](https://github.com/danielbair) helped improving the setup script.\n\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Freadbeyond%2Faeneas-vagrant","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Freadbeyond%2Faeneas-vagrant","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Freadbeyond%2Faeneas-vagrant/lists"}