PyLabRobot
Overview
PyLabRobot is a hardware-agnostic, pure Python Software Development Kit for automated and autonomous laboratories. Use this skill to control liquid handling robots, plate readers, pumps, heater shakers, incubators, centrifuges, and other laboratory automation equipment through a unified Python interface that works across platforms (Windows, macOS, Linux).
When to Use This Skill
Use this skill when:
- Programming liquid handling robots (Hamilton STAR/STARlet, Opentrons OT-2, Tecan EVO)
- Automating laboratory workflows involving pipetting, sample preparation, or analytical measurements
- Managing deck layouts and laboratory resources (plates, tips, containers, troughs)
- Integrating multiple lab devices (liquid handlers, plate readers, heater shakers, pumps)
- Creating reproducible laboratory protocols with state management
- Simulating protocols before running on physical hardware
- Reading plates using BMG CLARIOstar or other supported plate readers
- Controlling temperature, shaking, centrifugation, or other material handling operations
- Working with laboratory automation in Python
Core Capabilities
PyLabRobot provides comprehensive laboratory automation through six main capability areas, each detailed in the references/ directory:
1. Liquid Handling (references/liquid-handling.md)
Control liquid handling robots for aspirating, dispensing, and transferring liquids. Key operations include:
- Basic Operations: Aspirate, dispense, transfer liquids between wells
- Tip Management: Pick up, drop, and track pipette tips automatically
- Advanced Techniques: Multi-channel pipetting, serial dilutions, plate replication
- Volume Tracking: Automatic tracking of liquid volumes in wells
- Hardware Support: Hamilton STAR/STARlet, Opentrons OT-2, Tecan EVO, and others
2. Resource Management (references/resources.md)
Manage laboratory resources in a hierarchical system:
- Resource Types: Plates, tip racks, troughs, tubes, carriers, and custom labware
- Deck Layout: Assign resources to deck positions with coordinate systems
- State Management: Track tip presence, liquid volumes, and resource states
- Serialization: Save and load deck layouts and states from JSON files
- Resource Discovery: Access wells, tips, and containers through intuitive APIs
3. Hardware Backends (references/hardware-backends.md)
Connect to diverse laboratory equipment through backend abstraction:
- Liquid Handlers: Hamilton STAR (full support), Opentrons OT-2, Tecan EVO
- Simulation: ChatterboxBackend for protocol testing without hardware
- Platform Support: Works on Windows, macOS, Linux, and Raspberry Pi
- Backend Switching: Change robots by swapping backend without rewriting protocols
4. Analytical Equipment (references/analytical-equipment.md)
Integrate plate readers and analytical instruments:
- Plate Readers: BMG CLARIOstar for absorbance, luminescence, fluorescence
- Scales: Mettler Toledo integration for mass measurements
- Integration Patterns: Combine liquid handlers with analytical equipment
- Automated Workflows: Move plates between devices automatically
5. Material Handling (references/material-handling.md)
Control environmental and material handling equipment:
- Heater Shakers: Hamilton HeaterShaker, Inheco ThermoShake
- Incubators: Inheco and Thermo Fisher incubators with temperature control
- Centrifuges: Agilent VSpin with bucket positioning and spin control
- Pumps: Cole Parmer Masterflex for fluid pumping operations
- Temperature Control: Set and monitor temperatures during protocols
6. Visualization & Simulation (references/visualization.md)
Visualize and simulate laboratory protocols:
- Browser Visualizer: Real-time 3D visualization of deck state
- Simulation Mode: Test protocols without physical hardware
- State Tracking: Monitor tip presence and liquid volumes visually
- Deck Editor: Graphical tool for designing deck layouts
- Protocol Validation: Verify protocols before running on hardware
Quick Start
To get started with PyLabRobot, install the package and initialize a liquid handler:
# Install PyLabRobot
# uv pip install pylabrobot
# Basic liquid handling setup
from pylabrobot.liquid_handling import LiquidHandler
from pylabrobot.liquid_handling.backends import STARBackend
from pylabrobot.resources import STARLetDeck
# Initialize liquid handler
lh = LiquidHandler(backend=STARBackend(), deck=STARLetDeck())
await lh.setup()
# Basic operations
await lh.pick_up_tips(tip_rack["A1:H1"])
await lh.aspirate(plate["A1"], vols=100)
await lh.dispense(plate["A2"], vols=100)
await lh.drop_tips()
Working with References
This skill organizes detailed information across multiple reference files. Load the relevant reference when:
- Liquid Handling: Writing pipetting protocols, tip management, transfers
- Resources: Defining deck layouts, managing plates/tips, custom labware
- Hardware Backends: Connecting to specific robots, switching platforms
- Analytical Equipment: Integrating plate readers, scales, or analytical devices
- Material Handling: Using heater shakers, incubators, centrifuges, pumps
- Visualization: Simulating protocols, visualizing deck states
All reference files can be found in the references/ directory and contain comprehensive examples, API usage patterns, and best practices.
Best Practices
When creating laboratory automation protocols with PyLabRobot:
- Start with Simulation: Use ChatterboxBackend and the visualizer to test protocols before running on hardware
- Enable Tracking: Turn on tip tracking and volume tracking for accurate state management
- Resource Naming: Use clear, descriptive names for all resources (plates, tip racks, containers)
- State Serialization: Save deck layouts and states to JSON for reproducibility
- Error Handling: Implement proper async error handling for hardware operations
- Temperature Control: Set temperatures early as heating/cooling takes time
- Modular Protocols: Break complex workflows into reusable functions
- Documentation: Reference official docs at https://docs.pylabrobot.org for latest features
Common Workflows
Liquid Transfer Protocol
# Setup
lh = LiquidHandler(backend=STARBackend(), deck=STARLetDeck())
await lh.setup()
# Define resources
tip_rack = TIP_CAR_480_A00(name="tip_rack")
source_plate = Cos_96_DW_1mL(name="source")
dest_plate = Cos_96_DW_1mL(name="dest")
lh.deck.assign_child_resource(tip_rack, rails=1)
lh.deck.assign_child_resource(source_plate, rails=10)
lh.deck.assign_child_resource(dest_plate, rails=15)
# Transfer protocol
await lh.pick_up_tips(tip_rack["A1:H1"])
await lh.transfer(source_plate["A1:H12"], dest_plate["A1:H12"], vols=100)
await lh.drop_tips()
Plate Reading Workflow
# Setup plate reader
from pylabrobot.plate_reading import PlateReader
from pylabrobot.plate_reading.clario_star_backend import CLARIOstarBackend
pr = PlateReader(name="CLARIOstar", backend=CLARIOstarBackend())
await pr.setup()
# Set temperature and read
await pr.set_temperature(37)
await pr.open()
# (manually or robotically load plate)
await pr.close()
data = await pr.read_absorbance(wavelength=450)
Additional Resources
For detailed usage of specific capabilities, refer to the corresponding reference file in the references/ directory.
1---2name: pylabrobot3description: Vendor-agnostic lab automation framework. Use when controlling multiple equipment types (Hamilton, Tecan, Opentrons, plate readers, pumps) or needing unified programming across different vendors. Best for complex workflows, multi-vendor setups, simulation. For Opentrons-only protocols with official API, opentrons-integration may be simpler.4license: MIT license5metadata:6 source: https://skillmd.com/skills/stanfish06/pylabrobot7 version: "1.0"8 skill-author: K-Dense Inc.9---1011# PyLabRobot1213## Overview1415PyLabRobot is a hardware-agnostic, pure Python Software Development Kit for automated and autonomous laboratories. Use this skill to control liquid handling robots, plate readers, pumps, heater shakers, incubators, centrifuges, and other laboratory automation equipment through a unified Python interface that works across platforms (Windows, macOS, Linux).1617## When to Use This Skill1819Use this skill when:20- Programming liquid handling robots (Hamilton STAR/STARlet, Opentrons OT-2, Tecan EVO)21- Automating laboratory workflows involving pipetting, sample preparation, or analytical measurements22- Managing deck layouts and laboratory resources (plates, tips, containers, troughs)23- Integrating multiple lab devices (liquid handlers, plate readers, heater shakers, pumps)24- Creating reproducible laboratory protocols with state management25- Simulating protocols before running on physical hardware26- Reading plates using BMG CLARIOstar or other supported plate readers27- Controlling temperature, shaking, centrifugation, or other material handling operations28- Working with laboratory automation in Python2930## Core Capabilities3132PyLabRobot provides comprehensive laboratory automation through six main capability areas, each detailed in the references/ directory:3334### 1. Liquid Handling (`references/liquid-handling.md`)3536Control liquid handling robots for aspirating, dispensing, and transferring liquids. Key operations include:37- **Basic Operations**: Aspirate, dispense, transfer liquids between wells38- **Tip Management**: Pick up, drop, and track pipette tips automatically39- **Advanced Techniques**: Multi-channel pipetting, serial dilutions, plate replication40- **Volume Tracking**: Automatic tracking of liquid volumes in wells41- **Hardware Support**: Hamilton STAR/STARlet, Opentrons OT-2, Tecan EVO, and others4243### 2. Resource Management (`references/resources.md`)4445Manage laboratory resources in a hierarchical system:46- **Resource Types**: Plates, tip racks, troughs, tubes, carriers, and custom labware47- **Deck Layout**: Assign resources to deck positions with coordinate systems48- **State Management**: Track tip presence, liquid volumes, and resource states49- **Serialization**: Save and load deck layouts and states from JSON files50- **Resource Discovery**: Access wells, tips, and containers through intuitive APIs5152### 3. Hardware Backends (`references/hardware-backends.md`)5354Connect to diverse laboratory equipment through backend abstraction:55- **Liquid Handlers**: Hamilton STAR (full support), Opentrons OT-2, Tecan EVO56- **Simulation**: ChatterboxBackend for protocol testing without hardware57- **Platform Support**: Works on Windows, macOS, Linux, and Raspberry Pi58- **Backend Switching**: Change robots by swapping backend without rewriting protocols5960### 4. Analytical Equipment (`references/analytical-equipment.md`)6162Integrate plate readers and analytical instruments:63- **Plate Readers**: BMG CLARIOstar for absorbance, luminescence, fluorescence64- **Scales**: Mettler Toledo integration for mass measurements65- **Integration Patterns**: Combine liquid handlers with analytical equipment66- **Automated Workflows**: Move plates between devices automatically6768### 5. Material Handling (`references/material-handling.md`)6970Control environmental and material handling equipment:71- **Heater Shakers**: Hamilton HeaterShaker, Inheco ThermoShake72- **Incubators**: Inheco and Thermo Fisher incubators with temperature control73- **Centrifuges**: Agilent VSpin with bucket positioning and spin control74- **Pumps**: Cole Parmer Masterflex for fluid pumping operations75- **Temperature Control**: Set and monitor temperatures during protocols7677### 6. Visualization & Simulation (`references/visualization.md`)7879Visualize and simulate laboratory protocols:80- **Browser Visualizer**: Real-time 3D visualization of deck state81- **Simulation Mode**: Test protocols without physical hardware82- **State Tracking**: Monitor tip presence and liquid volumes visually83- **Deck Editor**: Graphical tool for designing deck layouts84- **Protocol Validation**: Verify protocols before running on hardware8586## Quick Start8788To get started with PyLabRobot, install the package and initialize a liquid handler:8990```python91# Install PyLabRobot92# uv pip install pylabrobot9394# Basic liquid handling setup95from pylabrobot.liquid_handling import LiquidHandler96from pylabrobot.liquid_handling.backends import STARBackend97from pylabrobot.resources import STARLetDeck9899# Initialize liquid handler100lh = LiquidHandler(backend=STARBackend(), deck=STARLetDeck())101await lh.setup()102103# Basic operations104await lh.pick_up_tips(tip_rack["A1:H1"])105await lh.aspirate(plate["A1"], vols=100)106await lh.dispense(plate["A2"], vols=100)107await lh.drop_tips()108```109110## Working with References111112This skill organizes detailed information across multiple reference files. Load the relevant reference when:113- **Liquid Handling**: Writing pipetting protocols, tip management, transfers114- **Resources**: Defining deck layouts, managing plates/tips, custom labware115- **Hardware Backends**: Connecting to specific robots, switching platforms116- **Analytical Equipment**: Integrating plate readers, scales, or analytical devices117- **Material Handling**: Using heater shakers, incubators, centrifuges, pumps118- **Visualization**: Simulating protocols, visualizing deck states119120All reference files can be found in the `references/` directory and contain comprehensive examples, API usage patterns, and best practices.121122## Best Practices123124When creating laboratory automation protocols with PyLabRobot:1251261. **Start with Simulation**: Use ChatterboxBackend and the visualizer to test protocols before running on hardware1272. **Enable Tracking**: Turn on tip tracking and volume tracking for accurate state management1283. **Resource Naming**: Use clear, descriptive names for all resources (plates, tip racks, containers)1294. **State Serialization**: Save deck layouts and states to JSON for reproducibility1305. **Error Handling**: Implement proper async error handling for hardware operations1316. **Temperature Control**: Set temperatures early as heating/cooling takes time1327. **Modular Protocols**: Break complex workflows into reusable functions1338. **Documentation**: Reference official docs at https://docs.pylabrobot.org for latest features134135## Common Workflows136137### Liquid Transfer Protocol138139```python140# Setup141lh = LiquidHandler(backend=STARBackend(), deck=STARLetDeck())142await lh.setup()143144# Define resources145tip_rack = TIP_CAR_480_A00(name="tip_rack")146source_plate = Cos_96_DW_1mL(name="source")147dest_plate = Cos_96_DW_1mL(name="dest")148149lh.deck.assign_child_resource(tip_rack, rails=1)150lh.deck.assign_child_resource(source_plate, rails=10)151lh.deck.assign_child_resource(dest_plate, rails=15)152153# Transfer protocol154await lh.pick_up_tips(tip_rack["A1:H1"])155await lh.transfer(source_plate["A1:H12"], dest_plate["A1:H12"], vols=100)156await lh.drop_tips()157```158159### Plate Reading Workflow160161```python162# Setup plate reader163from pylabrobot.plate_reading import PlateReader164from pylabrobot.plate_reading.clario_star_backend import CLARIOstarBackend165166pr = PlateReader(name="CLARIOstar", backend=CLARIOstarBackend())167await pr.setup()168169# Set temperature and read170await pr.set_temperature(37)171await pr.open()172# (manually or robotically load plate)173await pr.close()174data = await pr.read_absorbance(wavelength=450)175```176177## Additional Resources178179- **Official Documentation**: https://docs.pylabrobot.org180- **GitHub Repository**: https://github.com/PyLabRobot/pylabrobot181- **Community Forum**: https://discuss.pylabrobot.org182- **PyPI Package**: https://pypi.org/project/PyLabRobot/183184For detailed usage of specific capabilities, refer to the corresponding reference file in the `references/` directory.185