Skip to content

Virtualitics SDK Documentation

Welcome to the Virtualitics SDK documentation. The Virtualitics SDK is a powerful Python framework for building interactive data applications and workflows on the Virtualitics AI Platform.

What is the Virtualitics SDK?

The Virtualitics SDK allows you to:

  • Build Interactive Apps: Create multi-step workflows with rich UI components
  • Process Data: Work with datasets, models, and schemas
  • Create Visualizations: Build interactive plots, tables, and dashboards
  • Integrate AI: Leverage LLM capabilities through IRIS integration
  • Deploy Seamlessly: Package and deploy apps to the Virtualitics AI Platform

Quick Start

Get started with a simple "Hello World" app:

from virtualitics_sdk import App, Step, Page, Section, RichText

class HelloStep(Step):
    def run(self, flow_metadata):
        return Page(
            title="Hello World",
            sections=[
                Section(
                    title="Welcome",
                    cards=[RichText("# Hello from Virtualitics SDK!")]
                )
            ]
        )

# Create the app
app = App(
    name="Hello World",
    description="My first Virtualitics app"
)

# Add the step
hello_step = HelloStep(
    title="Hello",
    description="A simple greeting",
    parent="Main",
    type=StepType.RESULTS,
    page=Page(title="Hello", sections=[])
)

app.chain([hello_step])

Key Concepts

Apps & Workflows

Apps are the top-level containers for your workflows. They consist of multiple Steps that execute sequentially or conditionally.

Learn more about Apps →

Steps

Steps are the building blocks of apps. Each step can take inputs, process data, and display results.

Learn more about Steps →

Pages & UI

Pages contain the user interface for each step, organized into Sections and Cards with various Elements.

Learn more about Pages →

Elements

Elements are UI components like Tables, Plots, Dropdowns, and more that make your apps interactive.

Learn more about Elements →

Data Flow

Data flows between steps using Links, enabling complex multi-step workflows.

Learn more about Data Flow →

Installation

The Virtualitics SDK is bundled with the Virtualitics AI Platform — no separate install is required when developing apps that ship to a deployed platform.

For CLI tools to upload and manage apps:

pip install virtualitics-cli

Next Steps

Resources

Support

For questions, issues, or feature requests, please contact the Virtualitics team or file an issue in the GitHub repository.

Version Information

Use the version selector in the header to switch between documentation versions.