Automata LINQ SDK

Contents:

• Automata LINQ SDK
• Installation
• Getting Started
  • Configuration
  • Authentication
  • Running a Simple Example
• CLI Quickstart
  • Validating and planing a workflow
• Topics
  • Authentication and Configuration
  • Tasks and Transport
  • Time and Sequence
  • Labware Flow
  • Instruments and Drivers
  • Planning and Validation
  • Workflow Execution
  • Error Handling
  • Operator Intervention
  • Data Manipulation
  • Workflow Notifications
  • Workflow Branching
  • Runtime Parameters
  • Batching
• Concepts
  • LINQ API Client
  • Labware
  • Tasks
  • Workflow
  • Workcell
  • Webhooks
• Tutorials
  • Example Workflows
  • Conditionals

Introduction

This documentation is for the Automata LINQ SDK. The SDK provides a set of tools for working with the Automata LINQ platform, whether that is for creating and managing workflows, or for planning and executing on hardware.

How to use these docs

The documentation is organized into several sections: - Installation, Getting Started, and LINQ CLI guide you through setting up the SDK and running your first workflow.

• Topics provides detailed information on key features and fundamental use cases of the LINQ platform.

• Concepts is reference documentation for the core classes of the LINQ SDK.

• Tutorials provide step-by-step guides for common ways of using the LINQ platform.

LINQ SDK and API

The SDK is a Python package that provides a set of tools for working with the Automata LINQ platform. The SDK is built on top of the LINQ API, which is a RESTful API that provides access to the LINQ platform.

LINQ Command Line Interface (CLI)

The LINQ CLI is a command line interface that provides a set of tools for working with the Automata LINQ platform. The CLI is built on top of the LINQ SDK, and provides a way to invoke Python functions from the command line, making managing workflows and their execution easier.

Automata LINQ Concepts

The Automata LINQ platform is built around a set of core concepts that are used to define and manage workflows. These concepts include:

• Workcells: The workcell represents the physical lab setup in which your workflow operates. It includes the workbenches that hold the instruments and the transport systems that move labware between them. The workcell integrates all key components—workbenches, instruments, and transport mechanisms—into a unified system for managing and executing workflows.

• Instruments: An instrument is a physical device that is used to perform a task.

• Workflows: A workflow is a set of tasks that are executed in a specific order. Workflows can be created and managed using the LINQ SDK or the LINQ API.

• Tasks: A task is a unit of work that is executed as part of a workflow. Tasks can be physical tasks that are executed on hardware, or logical tasks that are executed in software.

• Planning: Planning is the process of creating a schedule (or plan) that defines how a workflow will be executed. Planning takes the graph of tasks described in a workflow and creates a definitive sequence of tasks that can be executed on hardware, optimized for utilization of the instruments on a workcell.

• Labware: Labware is the physical containers that hold samples and reagents. Labware can be moved between workbenches and instruments using the transport system.