SoloDB Documentation version 0.1-DEV Help

Experimental Split Feature

Introduction

The Experimental Split feature in SoloDB allows users to divide a run into multiple parts, organize them in a hierarchical structure, and map elements on each part. This feature is particularly useful for complex experiments where samples need to be divided, tracked, and processed separately.

Key Concepts

Parts

A Part represents a physical portion of an experiment run. Parts are organized in a hierarchical tree structure:

  • Root Parts: Top-level parts directly associated with a run

  • Child Parts: Sub-parts created by splitting a parent part

  • Parent Parts: Parts that have been split into child parts

Each part has:

  • A unique ID

  • A part ID (sequential number within its level)

  • A short label (automatically generated)

  • An optional custom label

  • Relationships to other parts (parent/children)

Layouts

A Layout defines the physical arrangement of a part. Layouts have:

  • A title

  • A description

  • A format

  • Dimensions (width and height)

Mappings

Mappings define specific elements on a part's layout. Each mapping has:

  • A label

  • Dimensions (width and height)

  • Position (X and Y coordinates)

Using the Experimental Split Feature

Viewing Parts

To view a part's details:

  1. Navigate to the run details page

  2. Find the part in the parts list

  3. Click on the part to view its details

The part details page shows:

  • Basic information (ID, labels)

  • Parent/child relationships

  • Layout information (if set)

  • Mapping information (if available)

Splitting Parts

To split a part into multiple child parts:

  1. Navigate to the part details page

  2. Click the "Split" button

  3. Enter the total number of parts to split into (must be at least the current number of children + 1)

  4. Click "Submit"

The system will create the specified number of child parts, each with:

  • A unique ID

  • A sequential part ID

  • An automatically generated short label

  • A relationship to the parent part

Mapping Parts

To map elements on a part:

  1. Navigate to the part details page

  2. Click the "Map" button

  3. Select a layout for the part (if not already set)

  4. Add, position, and size elements on the layout

  5. Click "Submit" to save the mapping

Editing Parts

To edit a part's properties:

  1. Navigate to the part details page

  2. Click the "Edit" button

  3. Modify the part's label or other properties

  4. Click "Submit" to save the changes

Part Labeling

Parts are automatically labeled based on the run's label type setting:

  • Number: Uses sequential numbers (1, 2, 3...)

  • Letter: Uses sequential letters (A, B, C...)

  • Sample Type: Uses a custom format based on the run's sample type

For parts with parent-child relationships, labels may include:

  • The parent part's label

  • A suffix indicating the child part's position

  • Additional information to ensure uniqueness

Part Hierarchy Visualization

The part hierarchy can be visualized in two ways:

  • As a tree structure showing parent-child relationships

  • As a table with levels displayed from top to bottom

Use Cases

Sample Division

When a sample needs to be divided into multiple portions for different tests or processes:

  1. Create a run with a single part

  2. Split the part into the required number of portions

  3. Process each child part separately

Multi-level Experiments

For experiments with multiple levels of division:

  1. Create a run with the initial parts

  2. Split parts as needed at each level

  3. Track the hierarchy to maintain relationships between parts

Layout Mapping

When specific areas of a part need to be identified and tracked:

  1. Create or select a part

  2. Assign a layout to the part

  3. Add mappings to identify specific elements or areas

  4. Reference these mappings in measurements or processing steps

21 May 2025