Get started

This tutorial is a step-by-step guide to install ADA. The software can be installed via (1) the use of installation scripts (Mac/Windows) or (2) manually for technical users.

Prerequisites

It is necessary to have a working Python installation on your computer. I recommend Anaconda for non-technical users and its installation is mandatory if you want to use the installation scripts. Technical users, who want to install ADA manually can use the usual channels for obtaining a Python distribution.

Anaconda is an open-source data science and includes programmings language like Python and R. It can be installed like any other program on your operating system. For the installation of Anaconda

download a copy for your operating system here

Please follow then the installation instructions

for Mac
for Windows
for Linux

Please do not change the settings or paths if you want use the installation scripts for ADA.

ADA installation

1. Download ADA

No binaries for different operating systems are available at the moment, so it is necessary to download the source files.

Go on the GitHub repository here.
Be sure that the branch main is selected
Click on Code
Click on Download zip to download the files

You should see a file adatool-main.zip in your Downloads folder. You can now unzip this archive on any location of your computer.

If you want to use the installation scripts for ADA, please follow the instructions in 2. See 3. for the manual installation.

2. Installation via scripts

This sections shows how to install ADA via scripts. These scripts are very basic, so please ensure that you remove adatool-main.zip archive before you run any of these scripts. Only the folder adatool-main should be on your computer.

If you are using Mac, you have to open the adatool-main folder. Then go on installation_scripts.

2.1 Mac

Mac users need to run the script install_ADA_MacOS.command. In order to run the script, you have to right-click onto the script and click on Open in the menu. It will not work otherwise, since this software is downloaded from the internet.

Pay Attention

Please be sure that adatoo-main is the only folder or file with this name. If you still have the adatool-main.zip file, please delete it.

2.2 Windows

Windows users need to run the script install_ADA_windows.bat by double-clicking on its icon. It should work out of the box. Enter <yes anytime the script asks for a reply. All necessary installation will be done by the script.

3. Manual installation

In the manual installation, the users need to create a Python environment first. This is done in the terminal for Mac and Linux users, or in the Anaconda prompt for Windows users. The environment for ADA is then created by entering the following command:

conda create --name ada_env Python=3.10

In the next step, the environment has to be activated by entering:

conda activate ada_env

When this is done, (ada_env) should be placed at the beginning or the end at the current terminal line. Finally, the necessary dependencies have to be installed. The list of these dependencies is given in the requirements.txt file located in the installation scripts folder, but only the path to this file is needed. They can be installed via the command:

pip3 install -r /path/to/the/requirements.txt

Running ADA

After the installation is completed, ADA can be started either by using a script for Mac or Windows, or manually

1. Start via script

1. Mac

Mac users must run the run_ADA_MacOS.command script. Similar to the installation script, the very first execution has to be done via right-click and then selecting Open. Another other execution afterwards can be done by a double click.

2. Windows

Windows users must run the run_ADA_Windows.bat script.

3. Manual start

For a manual start of ADA, Linux and Mac users have to open the terminal and Windows users the Anaconda prompt. Next, the ada_env environment has to be activated by:

conda activate ada_env

Finally, ADA can be started by executing the main.py file in the src subdirectory of the adatool-main folder:

python /path_to/adatool-main/src/main.py -style fusion