Skip to content

Installing CLAID packages

CLAID comes with a packaging system, that allows to include packages for various functionalities as required. You can find an overview of existing packages here. They can be installed using the claid manager tool, or by cloning them manually from the corresponding repository.

Installing the ModuleAPI package

CLAID's main package is the "ModuleAPI" package, which implements all of the core functionality of the framework. Before you can use CLAID in subsequent tutorials, you have to first install at least this package. If you have Python installed and followed the instructions for setting up the CLAID manager tool, you can simply use the CLAID package manager to install the package. Alternatively, you can also install packages manually. Both options are described below.

Installing the ModuleAPI package

If you followed the instructions above to install the necessary requirements for the CLAID manager tool, you can use it to install the package automatically. To use the claid manager tool to install packages, run the following commands from within a Python-enabled command line terminal:

On Linux & macOS:

claid install ModuleAPI

On Windows (Make sure to use a Python-enabled terminal! We highly recommend using Anaconda and running the claid tool from within the Anaconda Prompt):

%claid% install ModuleAPI

Clone the ModuleAPI repository into the "packages" folder of the CLAID installation directory:

git clone https://github.com/ADAMMA-CDHI-ETH-Zurich/ModuleAPI $CLAID_PATH/packages/ModuleAPI
Note: Under Windows, replace $CLAID_PATH with %CLAID_PATH%
If you want to install other packages manually, make sure to change the link to the github repository as well as the path $CLAID_PATH/packages/PACKAGE_NAME to match your required package name.

Done! If you completed all of the steps presented in this section successfully, you are now able to build your first applications using CLAID. Please proceed with the subsequent tutorials.