Installation

Since Annimate is a desktop-based application (as opposed to a website), you need to install it on your local system before you can use it.

The exact procedure depends on the operating system you are using. Annimate is currently available for Windows, Linux and macOS.

Windows

On Windows, Annimate comes with an installer that takes care of the installation process for you and can update your installation automatically whenever a new version of Annimate becomes available.

Note: Installing Annimate on Windows does not require administrator permissions. However, Annimate will only be installed for the current user, not system-wide.

In order to install Annimate, go through the following steps:

Download the installer .exe file from GitHub: Annimate_1.3.3_x64-setup.exe
Run the downloaded .exe file and follow the instructions of the installation wizard
Afterwards, you can run Annimate through the Windows start menu entry and/or the link on your desktop, depending on the options you chose in the installation wizard

Every time Annimate is started, it automatically checks for updates in the background. If there is an update, you are presented with a dialog telling you that an update is available and listing the most important changes. You can then choose to either

apply the update, or
skip the update for now.

If you choose to apply the update, the application will restart itself when the installation is completed. If you choose to skip the update, you will be reminded again the next time you start the application.

Note: We strongly recommend that you install updates in order to keep up with new features and bugfixes.

Linux

On Linux, Annimate comes in two different formats that you can choose from: an AppImage and a Debian package.

AppImage

The Annimate AppImage is a self-contained application bundle that includes all of its dependencies pre-bundled and runs on all common Linux distributions such as Ubuntu, Debian, openSUSE, RHEL, CentOS and Fedora without requiring a dedicated installation step. It can update itself automatically whenever a new version of Annimate becomes available.

In order to use the AppImage, go through the following steps:

Download the .AppImage file from GitHub: Annimate_1.3.3_amd64.AppImage
Make it executable:
```
chmod a+x Annimate*.AppImage
```
Afterwards, you can run Annimate by running the .AppImage file:
```
 ./Annimate*.AppImage
```

Automatic updates

apply the update, or
skip the update for now.

If you choose to apply the update, the application will restart itself afterwards. If you choose to skip the update, you will be reminded again the next time you start the application.

Note: We strongly recommend that you install updates in order to keep up with new features and bugfixes.

Since there is no dedicated installation step, updating in this case just means that the .AppImage file is replaced with a newly downloaded one. Note that the name of the .AppImage file (which includes a version number) stays the same, even though it now contains a newer version. If you want to avoid this, consider renaming the file to give it a version-independent name.

Debian Package

On Debian and its derivatives (such as Ubuntu), you can alternatively install Annimate from a Debian package. Note that this requires sudo privileges and does not support automatic updates.

In order to install the Debian package, go through the following steps:

Download the .deb file from GitHub: Annimate_1.3.3_amd64.deb
Install it:
```
sudo dpkg -i ./Annimate_*_amd64.deb
```
Start Annimate:
```
Annimate
```

macOS

On macOS, Annimate comes as a macOS Application Bundle (.app file) packaged in a .tar.gz archive. It can update itself automatically whenever a new version of Annimate becomes available.

Note: Installing Annimate on macOS does not require administrator permissions unless it is installed into a protected folder such as /Applications that requires adminitrator permissions. However, installing it into a protected folder is discouraged because it will not be able to update itself automatically.

There are two different versions of the Application Bundle for different types of processors:

Apple silicon processors (for newer Mac computers, starting from late 2020)
Intel processors (for older Mac computers)

Check the Apple Support to find out which type of processor you have. Annimate requires a macOS version of 10.13 “High Sierra” or newer.

Note: As the Annimate Application Bundle is not signed by Apple, your system will set a “quarantine” attribute for the downloaded file. You will need to remove this attribute as described below. Otherwise you will see a message saying that “Annimate is damaged and can’t be opened” when trying to start it.

In order to install Annimate, go through the following steps:

Download the .tar.gz file from GitHub:
- Annimate_aarch64.app.tar.gz for Apple silicon processors
- Annimate_x64.app.tar.gz for Intel processors
Double-click on the .tar.gz file in your Downloads folder to extract it:

This will produce an Annimate Application Bundle:
Move the Annimate Application Bundle to a folder that is not protected. This excludes folders that require administrator permissions such as /Applications, your desktop or other special folders in your home directory such as Documents or Downloads. You could, for instance, move it into your home directory or in a subfolder of your home directory such as ~/Applications that you may have to create first.
Open a terminal by clicking on the “Terminal” icon in your Dock:
In the terminal, go into the folder containing the Annimate Application Bundle (Annimate.app file) and run the following command to remove the quarantine attribute:
```
xattr -d com.apple.quarantine Annimate.app
```
The following screenshot shows a terminal session where the file is moved from the Downloads folder to the home directory (~) and the quarantine attribute is removed:
Afterwards you can run Annimate by double-clicking on the Annimate app icon (shown here in the home directory):

Automatic updates

apply the update, or
skip the update for now.

If you choose to apply the update, the application will restart itself afterwards. If you choose to skip the update, you will be reminded again the next time you start the application.

Note: We strongly recommend that you install updates in order to keep up with new features and bugfixes.

In case you see an error message when Annimate tries to install the update, make sure that the folder containing the Annimate Application Bundle does not require administrator permissions and isn’t one of the protected folders Desktop, Documents or Downloads.

Obtaining Older Versions

For reference, you can find the most recent and all previous releases of Annimate on the Releases page on GitHub.

What’s Next?

After you have successfully installed Annimate, you can proceed with Importing Corpus Data.

Annimate User Guide