Skip to content

Acoupi Technical Reference#

The acoupi Reference Section is helpful to find technical information about the inner-workings of acoupi and how it operates. In the following section, you will find more about the available acoupi functions.

  • Data: Responsible for defining a standardised data structure and ensuring that the flow of information between the other layers is validated and consistent. The data schema is composed of multiple data objects built using the Pydantic library, these correspond to attributes of Python classes.

  • Components: Form the building blocks of acoupi. They are individual elements (i.e., Python classes) designed to perform specific actions based on the configurations of a user. Their inputs and outputs follow the structure of the data.

  • Task: Integrate a sequence of one or more components executed in a specific flow.

  • Programs: Illustrate the complete set of tasks, components, and data schema.

  • System: Detailed functions used to manage running acoupi application.

Data

Ensure data validation and consistency.

Components

Building blocks of acoupi.

Tasks

Integrate sequences of one or more components.

Programs

Complete unit running on acoupi.

System

System Function.