🚀

Getting Started

Quickstart guide to install and set up the VoxKit application

VoxKit is a powerful forced alignment and voice analysis toolkit designed to conduct guided workflows in research environments. This guide will help you get started quickly.

System Requirements

  • Python 3.11 or higher
  • 4GB RAM minimum (8GB recommended)
  • 50MB free disk space

Installation

Follow these steps to install VoxKit on your system:

  • Download the appropriate bundle for your operating system from the VoxKit website (This Website).
  • If you plan to use Montreal Forced Aligner, be sure it is set up see https://montreal-forced-aligner.readthedocs.io/en/latest/reference/index.html.
  • Once the correct version is downloaded, follow the installation instructions below for any additional steps.

Choose your platform below for specific instructions.

macOS Installation

Open the dmg and drag voxkit to your Applications folder.

bash
# Disable quarantine mode for apps downloaded from the internet
xattr -cr ../VoxKit.app

Windows Installation

bash
# Testing in the works

Linux Installation

bash
# Testing in the works