Installation - Whombat

Skip to content

# Installation

Getting Whombat up and running is a breeze! We offer two straightforward methods to suit your preferences and needs.

Whombat on the cloud

Interested in hosting a publicly accessible and collaborative instance of Whombat? Let us know, and we'll be more than happy to guide you through the process.

## Installation Methods

### Standalone Executable

The simplest way to dive into Whombat is by downloading our pre-packaged executable file. We've tailored versions for Windows, Mac OS, and Ubuntu. Head over to our GitHub repository's releases section to get the latest version.

### Python Package

If you're comfortable with Python, installing Whombat as a Python package is easy. Just run the following command:

    pip install whombat

This should get you up and running in no time. Should you encounter any hiccups, check out the FAQ section for troubleshooting tips.

## Running Whombat

Once you've downloaded the file, kick off Whombat by double-clicking on the executable. This action spawns a new window that should resemble the following:

After the window displays the "ready" message a browser will be opened on Whombat, or open your preferred browser and navigate to:

    http://localhost:5000

Start with Python

To start whombat using the Python installation, run the command

    python -m whombat

## First User

If this is your initial encounter with Whombat, you'll be greeted with a screen to create your user profile. Please enter your details and set up your user account.

Your Information

The details you provide here are stored locally on your computer and are not shared with others. However, if you decide to download and share a dataset or annotations, the information of the user who created them will be visible in the exported files. Therefore, your data will only be shared with the people you send these files to. If you wish to share your work, it is essential to provide your information so that others can attribute you correctly and contact you if needed.

## Login

For returning users, Whombat welcomes you with a login form. Enter your username and password to access the home page. Whombat's user system supports multiple users, allowing for individual work tracking.

## Home Screen

Welcome to the Whombat Home screen! After logging in, your view should resemble the image below:

From this central hub, you're all set to dive into your audio annotation journey. Navigate using the sidebar or the cards presented on the home page. Whether you're managing datasets, creating annotation projects, or exploring model predictions, the Home screen is your launchpad to your annotation work.