Skip to main content

Introduction

Building an operation in Stage² involves breaking down a problem into modular components, selecting the right tool for one of these components, and then integrating the tool into the Stage² ecosystem. This guide will walk you through the process step by step, from problem definition to fully functional operation integration. By the end of this tutorial, you’ll have a clear understanding of how to design, containerize, and integrate an operation into Stage².

Overview of the Process

Creating an operation involves the following key steps:

  1. Breaking Down the Problem
    Understand the larger problem you're solving and break it into smaller, modular tasks. This step helps identify which parts of the workflow can be represented as operations.

  2. Choosing a Tool
    Identify the most appropriate tool to handle the specific task. Consider the tool's capabilities, input/output requirements, and compatibility with Stage²'s containerization system.

  3. Designing the Operation Interface
    Define the parameters and outputs for the operation. These parameters should abstract the tool's complexity and provide a user-friendly interface for configuring the operation.

  4. Containerizing the Tool
    Create a containerized version of the tool, using the stage2_interface.py script to bridge the tool's inputs and outputs with Stage²'s requirements.

  5. Integrating the Operation into Stage²
    Add the containerized tool to Stage², ensuring it connects properly with workflows, parameters, and the broader Stage² ecosystem.


How to Use This Guide

This guide is divided into sub-sections, each focusing on one step of the process. Here’s how you can navigate through the documentation:


By following this guide, you’ll not only learn the technical aspects of operation creation but also gain insights into designing workflows that maximize efficiency and adaptability. Let’s get started by breaking down the problem into modular components.