Repository files navigation

What is PyLabRobot?

PyLabRobot is a hardware agnostic, pure Python library for liquid handling robots, plate readers, pumps, scales, heater shakers, and other lab automation equipment. Read the paper in Device.

Advantages over proprietary software:

  • Cross-platform: PyLabRobot works on Windows, macOS, and Linux. Many other interfaces are Windows-only.
  • Universal: PyLabRobot works with any supported liquid handling robot, plate reader, pump, scale, heater shaker, etc. through a single interface.
  • Fast iteration: PyLabRobot enables rapid development of protocols using atomic commands run interactively in Jupyter notebooks or the Python REPL. This decreases iteration time from minutes to seconds.
  • Open-source: PyLabRobot is open-source and free to use.
  • Control: With Python, you have ultimate flexibility to control your lab automation equipment. You can write Turing-complete protocols that include feedback loops.
  • Modern: PyLabRobot is built on modern Python 3.9+ features and async/await syntax.
  • Fast support: PyLabRobot has an active community forum for support and discussion, and most pull requests are merged within a day.

Liquid handling robots (docs)

PyLabRobot enables the use of any liquid handling robot through a single universal interface, that works on any modern operating system (Windows, macOS, Linux). We currently support Hamilton STAR, Hamilton Vantage, Tecan Freedom EVO, and Opentrons OT-2 robots, but we will soon support many more.

Here's a quick example showing how to move 100uL of liquid from well A1 to A2 using firmware on Hamilton STAR (this will work on any operating system!):

frompylabrobot.liquid_handlingimportLiquidHandlerfrompylabrobot.liquid_handling.backendsimportSTARBackendfrompylabrobot.resourcesimportDeckdeck=Deck.load_from_json_file("hamilton-layout.json")
lh=LiquidHandler(backend=STARBackend(), deck=deck)
awaitlh.setup()
awaitlh.pick_up_tips(lh.deck.get_resource("tip_rack")["A1"])
awaitlh.aspirate(lh.deck.get_resource("plate")["A1"], vols=100)
awaitlh.dispense(lh.deck.get_resource("plate")["A2"], vols=100)
awaitlh.return_tips()

To run the same protocol on an Opentrons, use the following:

frompylabrobot.liquid_handling.backendsimportOpentronsOT2Backenddeck=Deck.load_from_json_file("opentrons-layout.json")
lh=LiquidHandler(backend=OpentronsOT2Backend(host="x.x.x.x"), deck=deck)

Or Tecan (also works on any operating system!):

frompylabrobot.liquid_handling.backendsimportEVOBackenddeck=Deck.load_from_json_file("tecan-layout.json")
lh=LiquidHandler(backend=EVOBackend(), deck=deck)

We also provide a browser-based Visualizer which can visualize the state of the deck during a run, and can be used to develop and test protocols without a physical robot.

Visualizer

Plate readers (docs)

Moving a plate to a ClarioStar using a liquid handler, and reading luminescence:

frompylabrobot.plate_readingimportPlateReader, CLARIOstarBackendpr=PlateReader(name="plate reader", backend=CLARIOstarBackend(), size_x=1, size_y=1, size_z=1)
awaitpr.setup()
# Use in combination with a liquid handlerlh.assign_child_resource(pr, location=Coordinate(x, y, z))
lh.move_plate(lh.deck.get_resource("plate"), pr)
data=awaitpr.read_luminescence()

For Cytation5, use the Cytation5 backend.

Centrifuges (docs)

Centrifugation at 800g for 60 seconds with an Agilent VSpin:

frompylabrobot.centrifugeimportCentrifuge, VSpinBackendvspin_backend=VSpinBackend(device_id="YOUR_FTDI_ID_HERE")
cf=Centrifuge(name="centrifuge", backend=vspin_backend, size_x=1, size_y=1, size_z=1)
awaitcf.setup()
awaitcf.spin(g=800, duration=60)

For a HighRes Biosolutions MicroSpin, use the MicroSpin factory:

frompylabrobot.centrifugeimportMicroSpincf=MicroSpin(name="microspin", host="192.168.127.60")
awaitcf.setup()
awaitcf.backend.home()
awaitcf.spin(g=800, duration=60)

Pumps (docs)

Pumping at 100 rpm for 30 seconds using a Masterflex pump:

frompylabrobot.pumpsimportPumpfrompylabrobot.pumps.cole_parmer.masterfleximportMasterflexp=Pump(backend=Masterflex())
awaitp.setup()
awaitp.run_for_duration(speed=100, duration=30)

Scales (docs)

Taking a measurement from a Mettler Toledo scale:

frompylabrobot.mettler_toledoimportMTSICSDriverscale=MTSICSDriver(port="/dev/cu.usbserial-110")
awaitscale.setup()
weight=awaitscale.read_weight()

Heater shakers (docs)

Setting the temperature of a heater shaker to 37°C:

frompylabrobot.heating_shakingimportHeaterShaker, InhecoThermoShakeBackendbackend=InhecoThermoShakeBackend()
hs=HeaterShaker(backend=backend, name="HeaterShaker", size_x=0, size_y=0, size_z=0)
awaiths.setup()
awaiths.set_temperature(37)

Fans (docs)

Running a fan at 100% intensity for one minute:

frompylabrobot.only_fansimportFanfrompylabrobot.only_fansimportHamiltonHepaFanBackendfan=Fan(backend=HamiltonHepaFanBackend(), name="my fan")
awaitfan.setup()
awaitfan.turn_on(intensity=100, duration=60)

Thermocyclers (docs)

Running a thermocycler with a simple protocol:

awaittc.run_pcr_profile(
denaturation_temp=98.0,
denaturation_time=10.0,
annealing_temp=55.0,
annealing_time=30.0,
extension_temp=72.0,
extension_time=60.0,
num_cycles=2,
block_max_volume=25.0,
lid_temperature=105.0,
pre_denaturation_temp=95.0,
pre_denaturation_time=180.0,
final_extension_temp=72.0,
final_extension_time=300.0,
storage_temp=4.0,
storage_time=600.0,
)

Resources

Documentation

docs.pylabrobot.org

Support

Citing

If you use PyLabRobot in your research, please cite the following:

@article{WIERENGA2023100111,
title = {PyLabRobot: An open-source, hardware-agnostic interface for liquid-handling robots and accessories},
journal = {Device},
volume = {1},
number = {4},
pages = {100111},
year = {2023},
issn = {2666-9986},
doi = {https://doi.org/10.1016/j.device.2023.100111},
url = {https://www.sciencedirect.com/science/article/pii/S2666998623001709},
author = {Rick P. Wierenga and Stefan M. Golas and Wilson Ho and Connor W. Coley and Kevin M. Esvelt},
keywords = {laboratory automation, open source, standardization, liquid-handling robots},
}

Disclaimer: PyLabRobot is not officially endorsed or supported by any robot manufacturer. If you use a firmware driver such as the STAR driver provided here, you do so at your own risk. Usage of a firmware driver such as STAR may invalidate your warranty. Please contact us with any questions.

Developed for the Sculpting Evolution Group at the MIT Media Lab

About

interactive & hardware agnostic SDK for lab automation

Topics

Resources

Contributing

Stars

524 stars

Watchers

14 watching

Forks

Releases

Packages

Used by

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content

Repository files navigation

What is PyLabRobot?

PyLabRobot is a hardware agnostic, pure Python library for liquid handling robots, plate readers, pumps, scales, heater shakers, and other lab automation equipment. Read the paper in Device.

Advantages over proprietary software:

  • Cross-platform: PyLabRobot works on Windows, macOS, and Linux. Many other interfaces are Windows-only.
  • Universal: PyLabRobot works with any supported liquid handling robot, plate reader, pump, scale, heater shaker, etc. through a single interface.
  • Fast iteration: PyLabRobot enables rapid development of protocols using atomic commands run interactively in Jupyter notebooks or the Python REPL. This decreases iteration time from minutes to seconds.
  • Open-source: PyLabRobot is open-source and free to use.
  • Control: With Python, you have ultimate flexibility to control your lab automation equipment. You can write Turing-complete protocols that include feedback loops.
  • Modern: PyLabRobot is built on modern Python 3.9+ features and async/await syntax.
  • Fast support: PyLabRobot has an active community forum for support and discussion, and most pull requests are merged within a day.

Liquid handling robots (docs)

PyLabRobot enables the use of any liquid handling robot through a single universal interface, that works on any modern operating system (Windows, macOS, Linux). We currently support Hamilton STAR, Hamilton Vantage, Tecan Freedom EVO, and Opentrons OT-2 robots, but we will soon support many more.

Here's a quick example showing how to move 100uL of liquid from well A1 to A2 using firmware on Hamilton STAR (this will work on any operating system!):

frompylabrobot.liquid_handlingimportLiquidHandlerfrompylabrobot.liquid_handling.backendsimportSTARBackendfrompylabrobot.resourcesimportDeckdeck=Deck.load_from_json_file("hamilton-layout.json")
lh=LiquidHandler(backend=STARBackend(), deck=deck)
awaitlh.setup()
awaitlh.pick_up_tips(lh.deck.get_resource("tip_rack")["A1"])
awaitlh.aspirate(lh.deck.get_resource("plate")["A1"], vols=100)
awaitlh.dispense(lh.deck.get_resource("plate")["A2"], vols=100)
awaitlh.return_tips()

To run the same protocol on an Opentrons, use the following:

frompylabrobot.liquid_handling.backendsimportOpentronsOT2Backenddeck=Deck.load_from_json_file("opentrons-layout.json")
lh=LiquidHandler(backend=OpentronsOT2Backend(host="x.x.x.x"), deck=deck)

Or Tecan (also works on any operating system!):

frompylabrobot.liquid_handling.backendsimportEVOBackenddeck=Deck.load_from_json_file("tecan-layout.json")
lh=LiquidHandler(backend=EVOBackend(), deck=deck)

We also provide a browser-based Visualizer which can visualize the state of the deck during a run, and can be used to develop and test protocols without a physical robot.

Visualizer

Plate readers (docs)

Moving a plate to a ClarioStar using a liquid handler, and reading luminescence:

frompylabrobot.plate_readingimportPlateReader, CLARIOstarBackendpr=PlateReader(name="plate reader", backend=CLARIOstarBackend(), size_x=1, size_y=1, size_z=1)
awaitpr.setup()
# Use in combination with a liquid handlerlh.assign_child_resource(pr, location=Coordinate(x, y, z))
lh.move_plate(lh.deck.get_resource("plate"), pr)
data=awaitpr.read_luminescence()

For Cytation5, use the Cytation5 backend.

Centrifuges (docs)

Centrifugation at 800g for 60 seconds with an Agilent VSpin:

frompylabrobot.centrifugeimportCentrifuge, VSpinBackendvspin_backend=VSpinBackend(device_id="YOUR_FTDI_ID_HERE")
cf=Centrifuge(name="centrifuge", backend=vspin_backend, size_x=1, size_y=1, size_z=1)
awaitcf.setup()
awaitcf.spin(g=800, duration=60)

For a HighRes Biosolutions MicroSpin, use the MicroSpin factory:

frompylabrobot.centrifugeimportMicroSpincf=MicroSpin(name="microspin", host="192.168.127.60")
awaitcf.setup()
awaitcf.backend.home()
awaitcf.spin(g=800, duration=60)

Pumps (docs)

Pumping at 100 rpm for 30 seconds using a Masterflex pump:

frompylabrobot.pumpsimportPumpfrompylabrobot.pumps.cole_parmer.masterfleximportMasterflexp=Pump(backend=Masterflex())
awaitp.setup()
awaitp.run_for_duration(speed=100, duration=30)

Scales (docs)

Taking a measurement from a Mettler Toledo scale:

frompylabrobot.mettler_toledoimportMTSICSDriverscale=MTSICSDriver(port="/dev/cu.usbserial-110")
awaitscale.setup()
weight=awaitscale.read_weight()

Heater shakers (docs)

Setting the temperature of a heater shaker to 37°C:

frompylabrobot.heating_shakingimportHeaterShaker, InhecoThermoShakeBackendbackend=InhecoThermoShakeBackend()
hs=HeaterShaker(backend=backend, name="HeaterShaker", size_x=0, size_y=0, size_z=0)
awaiths.setup()
awaiths.set_temperature(37)

Fans (docs)

Running a fan at 100% intensity for one minute:

frompylabrobot.only_fansimportFanfrompylabrobot.only_fansimportHamiltonHepaFanBackendfan=Fan(backend=HamiltonHepaFanBackend(), name="my fan")
awaitfan.setup()
awaitfan.turn_on(intensity=100, duration=60)

Thermocyclers (docs)

Running a thermocycler with a simple protocol:

awaittc.run_pcr_profile(
denaturation_temp=98.0,
denaturation_time=10.0,
annealing_temp=55.0,
annealing_time=30.0,
extension_temp=72.0,
extension_time=60.0,
num_cycles=2,
block_max_volume=25.0,
lid_temperature=105.0,
pre_denaturation_temp=95.0,
pre_denaturation_time=180.0,
final_extension_temp=72.0,
final_extension_time=300.0,
storage_temp=4.0,
storage_time=600.0,
)

Resources

Documentation

docs.pylabrobot.org

Support

Citing

If you use PyLabRobot in your research, please cite the following:

@article{WIERENGA2023100111,
title = {PyLabRobot: An open-source, hardware-agnostic interface for liquid-handling robots and accessories},
journal = {Device},
volume = {1},
number = {4},
pages = {100111},
year = {2023},
issn = {2666-9986},
doi = {https://doi.org/10.1016/j.device.2023.100111},
url = {https://www.sciencedirect.com/science/article/pii/S2666998623001709},
author = {Rick P. Wierenga and Stefan M. Golas and Wilson Ho and Connor W. Coley and Kevin M. Esvelt},
keywords = {laboratory automation, open source, standardization, liquid-handling robots},
}

Disclaimer: PyLabRobot is not officially endorsed or supported by any robot manufacturer. If you use a firmware driver such as the STAR driver provided here, you do so at your own risk. Usage of a firmware driver such as STAR may invalidate your warranty. Please contact us with any questions.

Developed for the Sculpting Evolution Group at the MIT Media Lab

About

interactive & hardware agnostic SDK for lab automation

Topics

Resources

Contributing

Stars

524 stars

Watchers

14 watching

Forks

Releases

Packages

Used by

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Repository files navigation

What is PyLabRobot?

PyLabRobot is a hardware agnostic, pure Python library for liquid handling robots, plate readers, pumps, scales, heater shakers, and other lab automation equipment. Read the paper in Device.

Advantages over proprietary software:

  • Cross-platform: PyLabRobot works on Windows, macOS, and Linux. Many other interfaces are Windows-only.
  • Universal: PyLabRobot works with any supported liquid handling robot, plate reader, pump, scale, heater shaker, etc. through a single interface.
  • Fast iteration: PyLabRobot enables rapid development of protocols using atomic commands run interactively in Jupyter notebooks or the Python REPL. This decreases iteration time from minutes to seconds.
  • Open-source: PyLabRobot is open-source and free to use.
  • Control: With Python, you have ultimate flexibility to control your lab automation equipment. You can write Turing-complete protocols that include feedback loops.
  • Modern: PyLabRobot is built on modern Python 3.9+ features and async/await syntax.
  • Fast support: PyLabRobot has an active community forum for support and discussion, and most pull requests are merged within a day.

Liquid handling robots (docs)

PyLabRobot enables the use of any liquid handling robot through a single universal interface, that works on any modern operating system (Windows, macOS, Linux). We currently support Hamilton STAR, Hamilton Vantage, Tecan Freedom EVO, and Opentrons OT-2 robots, but we will soon support many more.

Here's a quick example showing how to move 100uL of liquid from well A1 to A2 using firmware on Hamilton STAR (this will work on any operating system!):

frompylabrobot.liquid_handlingimportLiquidHandlerfrompylabrobot.liquid_handling.backendsimportSTARBackendfrompylabrobot.resourcesimportDeckdeck=Deck.load_from_json_file("hamilton-layout.json")
lh=LiquidHandler(backend=STARBackend(), deck=deck)
awaitlh.setup()
awaitlh.pick_up_tips(lh.deck.get_resource("tip_rack")["A1"])
awaitlh.aspirate(lh.deck.get_resource("plate")["A1"], vols=100)
awaitlh.dispense(lh.deck.get_resource("plate")["A2"], vols=100)
awaitlh.return_tips()

To run the same protocol on an Opentrons, use the following:

frompylabrobot.liquid_handling.backendsimportOpentronsOT2Backenddeck=Deck.load_from_json_file("opentrons-layout.json")
lh=LiquidHandler(backend=OpentronsOT2Backend(host="x.x.x.x"), deck=deck)

Or Tecan (also works on any operating system!):

frompylabrobot.liquid_handling.backendsimportEVOBackenddeck=Deck.load_from_json_file("tecan-layout.json")
lh=LiquidHandler(backend=EVOBackend(), deck=deck)

We also provide a browser-based Visualizer which can visualize the state of the deck during a run, and can be used to develop and test protocols without a physical robot.

Visualizer

Plate readers (docs)

Moving a plate to a ClarioStar using a liquid handler, and reading luminescence:

frompylabrobot.plate_readingimportPlateReader, CLARIOstarBackendpr=PlateReader(name="plate reader", backend=CLARIOstarBackend(), size_x=1, size_y=1, size_z=1)
awaitpr.setup()
# Use in combination with a liquid handlerlh.assign_child_resource(pr, location=Coordinate(x, y, z))
lh.move_plate(lh.deck.get_resource("plate"), pr)
data=awaitpr.read_luminescence()

For Cytation5, use the Cytation5 backend.

Centrifuges (docs)

Centrifugation at 800g for 60 seconds with an Agilent VSpin:

frompylabrobot.centrifugeimportCentrifuge, VSpinBackendvspin_backend=VSpinBackend(device_id="YOUR_FTDI_ID_HERE")
cf=Centrifuge(name="centrifuge", backend=vspin_backend, size_x=1, size_y=1, size_z=1)
awaitcf.setup()
awaitcf.spin(g=800, duration=60)

For a HighRes Biosolutions MicroSpin, use the MicroSpin factory:

frompylabrobot.centrifugeimportMicroSpincf=MicroSpin(name="microspin", host="192.168.127.60")
awaitcf.setup()
awaitcf.backend.home()
awaitcf.spin(g=800, duration=60)

Pumps (docs)

Pumping at 100 rpm for 30 seconds using a Masterflex pump:

frompylabrobot.pumpsimportPumpfrompylabrobot.pumps.cole_parmer.masterfleximportMasterflexp=Pump(backend=Masterflex())
awaitp.setup()
awaitp.run_for_duration(speed=100, duration=30)

Scales (docs)

Taking a measurement from a Mettler Toledo scale:

frompylabrobot.mettler_toledoimportMTSICSDriverscale=MTSICSDriver(port="/dev/cu.usbserial-110")
awaitscale.setup()
weight=awaitscale.read_weight()

Heater shakers (docs)

Setting the temperature of a heater shaker to 37°C:

frompylabrobot.heating_shakingimportHeaterShaker, InhecoThermoShakeBackendbackend=InhecoThermoShakeBackend()
hs=HeaterShaker(backend=backend, name="HeaterShaker", size_x=0, size_y=0, size_z=0)
awaiths.setup()
awaiths.set_temperature(37)

Fans (docs)

Running a fan at 100% intensity for one minute:

frompylabrobot.only_fansimportFanfrompylabrobot.only_fansimportHamiltonHepaFanBackendfan=Fan(backend=HamiltonHepaFanBackend(), name="my fan")
awaitfan.setup()
awaitfan.turn_on(intensity=100, duration=60)

Thermocyclers (docs)

Running a thermocycler with a simple protocol:

awaittc.run_pcr_profile(
denaturation_temp=98.0,
denaturation_time=10.0,
annealing_temp=55.0,
annealing_time=30.0,
extension_temp=72.0,
extension_time=60.0,
num_cycles=2,
block_max_volume=25.0,
lid_temperature=105.0,
pre_denaturation_temp=95.0,
pre_denaturation_time=180.0,
final_extension_temp=72.0,
final_extension_time=300.0,
storage_temp=4.0,
storage_time=600.0,
)

Resources

Documentation

docs.pylabrobot.org

Support

Citing

If you use PyLabRobot in your research, please cite the following:

@article{WIERENGA2023100111,
title = {PyLabRobot: An open-source, hardware-agnostic interface for liquid-handling robots and accessories},
journal = {Device},
volume = {1},
number = {4},
pages = {100111},
year = {2023},
issn = {2666-9986},
doi = {https://doi.org/10.1016/j.device.2023.100111},
url = {https://www.sciencedirect.com/science/article/pii/S2666998623001709},
author = {Rick P. Wierenga and Stefan M. Golas and Wilson Ho and Connor W. Coley and Kevin M. Esvelt},
keywords = {laboratory automation, open source, standardization, liquid-handling robots},
}

Disclaimer: PyLabRobot is not officially endorsed or supported by any robot manufacturer. If you use a firmware driver such as the STAR driver provided here, you do so at your own risk. Usage of a firmware driver such as STAR may invalidate your warranty. Please contact us with any questions.

Developed for the Sculpting Evolution Group at the MIT Media Lab

About

interactive & hardware agnostic SDK for lab automation

Topics

Resources

Contributing

Stars

524 stars

Watchers

14 watching

Forks

Releases

Packages

Used by

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Repository files navigation

What is PyLabRobot?

PyLabRobot is a hardware agnostic, pure Python library for liquid handling robots, plate readers, pumps, scales, heater shakers, and other lab automation equipment. Read the paper in Device.

Advantages over proprietary software:

  • Cross-platform: PyLabRobot works on Windows, macOS, and Linux. Many other interfaces are Windows-only.
  • Universal: PyLabRobot works with any supported liquid handling robot, plate reader, pump, scale, heater shaker, etc. through a single interface.
  • Fast iteration: PyLabRobot enables rapid development of protocols using atomic commands run interactively in Jupyter notebooks or the Python REPL. This decreases iteration time from minutes to seconds.
  • Open-source: PyLabRobot is open-source and free to use.
  • Control: With Python, you have ultimate flexibility to control your lab automation equipment. You can write Turing-complete protocols that include feedback loops.
  • Modern: PyLabRobot is built on modern Python 3.9+ features and async/await syntax.
  • Fast support: PyLabRobot has an active community forum for support and discussion, and most pull requests are merged within a day.

Liquid handling robots (docs)

PyLabRobot enables the use of any liquid handling robot through a single universal interface, that works on any modern operating system (Windows, macOS, Linux). We currently support Hamilton STAR, Hamilton Vantage, Tecan Freedom EVO, and Opentrons OT-2 robots, but we will soon support many more.

Here's a quick example showing how to move 100uL of liquid from well A1 to A2 using firmware on Hamilton STAR (this will work on any operating system!):

frompylabrobot.liquid_handlingimportLiquidHandlerfrompylabrobot.liquid_handling.backendsimportSTARBackendfrompylabrobot.resourcesimportDeckdeck=Deck.load_from_json_file("hamilton-layout.json")
lh=LiquidHandler(backend=STARBackend(), deck=deck)
awaitlh.setup()
awaitlh.pick_up_tips(lh.deck.get_resource("tip_rack")["A1"])
awaitlh.aspirate(lh.deck.get_resource("plate")["A1"], vols=100)
awaitlh.dispense(lh.deck.get_resource("plate")["A2"], vols=100)
awaitlh.return_tips()

To run the same protocol on an Opentrons, use the following:

frompylabrobot.liquid_handling.backendsimportOpentronsOT2Backenddeck=Deck.load_from_json_file("opentrons-layout.json")
lh=LiquidHandler(backend=OpentronsOT2Backend(host="x.x.x.x"), deck=deck)

Or Tecan (also works on any operating system!):

frompylabrobot.liquid_handling.backendsimportEVOBackenddeck=Deck.load_from_json_file("tecan-layout.json")
lh=LiquidHandler(backend=EVOBackend(), deck=deck)

We also provide a browser-based Visualizer which can visualize the state of the deck during a run, and can be used to develop and test protocols without a physical robot.

Visualizer

Plate readers (docs)

Moving a plate to a ClarioStar using a liquid handler, and reading luminescence:

frompylabrobot.plate_readingimportPlateReader, CLARIOstarBackendpr=PlateReader(name="plate reader", backend=CLARIOstarBackend(), size_x=1, size_y=1, size_z=1)
awaitpr.setup()
# Use in combination with a liquid handlerlh.assign_child_resource(pr, location=Coordinate(x, y, z))
lh.move_plate(lh.deck.get_resource("plate"), pr)
data=awaitpr.read_luminescence()

For Cytation5, use the Cytation5 backend.

Centrifuges (docs)

Centrifugation at 800g for 60 seconds with an Agilent VSpin:

frompylabrobot.centrifugeimportCentrifuge, VSpinBackendvspin_backend=VSpinBackend(device_id="YOUR_FTDI_ID_HERE")
cf=Centrifuge(name="centrifuge", backend=vspin_backend, size_x=1, size_y=1, size_z=1)
awaitcf.setup()
awaitcf.spin(g=800, duration=60)

For a HighRes Biosolutions MicroSpin, use the MicroSpin factory:

frompylabrobot.centrifugeimportMicroSpincf=MicroSpin(name="microspin", host="192.168.127.60")
awaitcf.setup()
awaitcf.backend.home()
awaitcf.spin(g=800, duration=60)

Pumps (docs)

Pumping at 100 rpm for 30 seconds using a Masterflex pump:

frompylabrobot.pumpsimportPumpfrompylabrobot.pumps.cole_parmer.masterfleximportMasterflexp=Pump(backend=Masterflex())
awaitp.setup()
awaitp.run_for_duration(speed=100, duration=30)

Scales (docs)

Taking a measurement from a Mettler Toledo scale:

frompylabrobot.mettler_toledoimportMTSICSDriverscale=MTSICSDriver(port="/dev/cu.usbserial-110")
awaitscale.setup()
weight=awaitscale.read_weight()

Heater shakers (docs)

Setting the temperature of a heater shaker to 37°C:

frompylabrobot.heating_shakingimportHeaterShaker, InhecoThermoShakeBackendbackend=InhecoThermoShakeBackend()
hs=HeaterShaker(backend=backend, name="HeaterShaker", size_x=0, size_y=0, size_z=0)
awaiths.setup()
awaiths.set_temperature(37)

Fans (docs)

Running a fan at 100% intensity for one minute:

frompylabrobot.only_fansimportFanfrompylabrobot.only_fansimportHamiltonHepaFanBackendfan=Fan(backend=HamiltonHepaFanBackend(), name="my fan")
awaitfan.setup()
awaitfan.turn_on(intensity=100, duration=60)

Thermocyclers (docs)

Running a thermocycler with a simple protocol:

awaittc.run_pcr_profile(
denaturation_temp=98.0,
denaturation_time=10.0,
annealing_temp=55.0,
annealing_time=30.0,
extension_temp=72.0,
extension_time=60.0,
num_cycles=2,
block_max_volume=25.0,
lid_temperature=105.0,
pre_denaturation_temp=95.0,
pre_denaturation_time=180.0,
final_extension_temp=72.0,
final_extension_time=300.0,
storage_temp=4.0,
storage_time=600.0,
)

Resources

Documentation

docs.pylabrobot.org

Support

Citing

If you use PyLabRobot in your research, please cite the following:

@article{WIERENGA2023100111,
title = {PyLabRobot: An open-source, hardware-agnostic interface for liquid-handling robots and accessories},
journal = {Device},
volume = {1},
number = {4},
pages = {100111},
year = {2023},
issn = {2666-9986},
doi = {https://doi.org/10.1016/j.device.2023.100111},
url = {https://www.sciencedirect.com/science/article/pii/S2666998623001709},
author = {Rick P. Wierenga and Stefan M. Golas and Wilson Ho and Connor W. Coley and Kevin M. Esvelt},
keywords = {laboratory automation, open source, standardization, liquid-handling robots},
}

Disclaimer: PyLabRobot is not officially endorsed or supported by any robot manufacturer. If you use a firmware driver such as the STAR driver provided here, you do so at your own risk. Usage of a firmware driver such as STAR may invalidate your warranty. Please contact us with any questions.

Developed for the Sculpting Evolution Group at the MIT Media Lab

About

interactive & hardware agnostic SDK for lab automation

Topics

Resources

Contributing

Stars

524 stars

Watchers

14 watching

Forks

Releases

Packages

Used by

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content

Repository files navigation

What is PyLabRobot?

PyLabRobot is a hardware agnostic, pure Python library for liquid handling robots, plate readers, pumps, scales, heater shakers, and other lab automation equipment. Read the paper in Device.

Advantages over proprietary software:

  • Cross-platform: PyLabRobot works on Windows, macOS, and Linux. Many other interfaces are Windows-only.
  • Universal: PyLabRobot works with any supported liquid handling robot, plate reader, pump, scale, heater shaker, etc. through a single interface.
  • Fast iteration: PyLabRobot enables rapid development of protocols using atomic commands run interactively in Jupyter notebooks or the Python REPL. This decreases iteration time from minutes to seconds.
  • Open-source: PyLabRobot is open-source and free to use.
  • Control: With Python, you have ultimate flexibility to control your lab automation equipment. You can write Turing-complete protocols that include feedback loops.
  • Modern: PyLabRobot is built on modern Python 3.9+ features and async/await syntax.
  • Fast support: PyLabRobot has an active community forum for support and discussion, and most pull requests are merged within a day.

Liquid handling robots (docs)

PyLabRobot enables the use of any liquid handling robot through a single universal interface, that works on any modern operating system (Windows, macOS, Linux). We currently support Hamilton STAR, Hamilton Vantage, Tecan Freedom EVO, and Opentrons OT-2 robots, but we will soon support many more.

Here's a quick example showing how to move 100uL of liquid from well A1 to A2 using firmware on Hamilton STAR (this will work on any operating system!):

frompylabrobot.liquid_handlingimportLiquidHandlerfrompylabrobot.liquid_handling.backendsimportSTARBackendfrompylabrobot.resourcesimportDeckdeck=Deck.load_from_json_file("hamilton-layout.json")
lh=LiquidHandler(backend=STARBackend(), deck=deck)
awaitlh.setup()
awaitlh.pick_up_tips(lh.deck.get_resource("tip_rack")["A1"])
awaitlh.aspirate(lh.deck.get_resource("plate")["A1"], vols=100)
awaitlh.dispense(lh.deck.get_resource("plate")["A2"], vols=100)
awaitlh.return_tips()

To run the same protocol on an Opentrons, use the following:

frompylabrobot.liquid_handling.backendsimportOpentronsOT2Backenddeck=Deck.load_from_json_file("opentrons-layout.json")
lh=LiquidHandler(backend=OpentronsOT2Backend(host="x.x.x.x"), deck=deck)

Or Tecan (also works on any operating system!):

frompylabrobot.liquid_handling.backendsimportEVOBackenddeck=Deck.load_from_json_file("tecan-layout.json")
lh=LiquidHandler(backend=EVOBackend(), deck=deck)

We also provide a browser-based Visualizer which can visualize the state of the deck during a run, and can be used to develop and test protocols without a physical robot.

Visualizer

Plate readers (docs)

Moving a plate to a ClarioStar using a liquid handler, and reading luminescence:

frompylabrobot.plate_readingimportPlateReader, CLARIOstarBackendpr=PlateReader(name="plate reader", backend=CLARIOstarBackend(), size_x=1, size_y=1, size_z=1)
awaitpr.setup()
# Use in combination with a liquid handlerlh.assign_child_resource(pr, location=Coordinate(x, y, z))
lh.move_plate(lh.deck.get_resource("plate"), pr)
data=awaitpr.read_luminescence()

For Cytation5, use the Cytation5 backend.

Centrifuges (docs)

Centrifugation at 800g for 60 seconds with an Agilent VSpin:

frompylabrobot.centrifugeimportCentrifuge, VSpinBackendvspin_backend=VSpinBackend(device_id="YOUR_FTDI_ID_HERE")
cf=Centrifuge(name="centrifuge", backend=vspin_backend, size_x=1, size_y=1, size_z=1)
awaitcf.setup()
awaitcf.spin(g=800, duration=60)

For a HighRes Biosolutions MicroSpin, use the MicroSpin factory:

frompylabrobot.centrifugeimportMicroSpincf=MicroSpin(name="microspin", host="192.168.127.60")
awaitcf.setup()
awaitcf.backend.home()
awaitcf.spin(g=800, duration=60)

Pumps (docs)

Pumping at 100 rpm for 30 seconds using a Masterflex pump:

frompylabrobot.pumpsimportPumpfrompylabrobot.pumps.cole_parmer.masterfleximportMasterflexp=Pump(backend=Masterflex())
awaitp.setup()
awaitp.run_for_duration(speed=100, duration=30)

Scales (docs)

Taking a measurement from a Mettler Toledo scale:

frompylabrobot.mettler_toledoimportMTSICSDriverscale=MTSICSDriver(port="/dev/cu.usbserial-110")
awaitscale.setup()
weight=awaitscale.read_weight()

Heater shakers (docs)

Setting the temperature of a heater shaker to 37°C:

frompylabrobot.heating_shakingimportHeaterShaker, InhecoThermoShakeBackendbackend=InhecoThermoShakeBackend()
hs=HeaterShaker(backend=backend, name="HeaterShaker", size_x=0, size_y=0, size_z=0)
awaiths.setup()
awaiths.set_temperature(37)

Fans (docs)

Running a fan at 100% intensity for one minute:

frompylabrobot.only_fansimportFanfrompylabrobot.only_fansimportHamiltonHepaFanBackendfan=Fan(backend=HamiltonHepaFanBackend(), name="my fan")
awaitfan.setup()
awaitfan.turn_on(intensity=100, duration=60)

Thermocyclers (docs)

Running a thermocycler with a simple protocol:

awaittc.run_pcr_profile(
denaturation_temp=98.0,
denaturation_time=10.0,
annealing_temp=55.0,
annealing_time=30.0,
extension_temp=72.0,
extension_time=60.0,
num_cycles=2,
block_max_volume=25.0,
lid_temperature=105.0,
pre_denaturation_temp=95.0,
pre_denaturation_time=180.0,
final_extension_temp=72.0,
final_extension_time=300.0,
storage_temp=4.0,
storage_time=600.0,
)

Resources

Documentation

docs.pylabrobot.org

Support

Citing

If you use PyLabRobot in your research, please cite the following:

@article{WIERENGA2023100111,
title = {PyLabRobot: An open-source, hardware-agnostic interface for liquid-handling robots and accessories},
journal = {Device},
volume = {1},
number = {4},
pages = {100111},
year = {2023},
issn = {2666-9986},
doi = {https://doi.org/10.1016/j.device.2023.100111},
url = {https://www.sciencedirect.com/science/article/pii/S2666998623001709},
author = {Rick P. Wierenga and Stefan M. Golas and Wilson Ho and Connor W. Coley and Kevin M. Esvelt},
keywords = {laboratory automation, open source, standardization, liquid-handling robots},
}

Disclaimer: PyLabRobot is not officially endorsed or supported by any robot manufacturer. If you use a firmware driver such as the STAR driver provided here, you do so at your own risk. Usage of a firmware driver such as STAR may invalidate your warranty. Please contact us with any questions.

Developed for the Sculpting Evolution Group at the MIT Media Lab

About

interactive & hardware agnostic SDK for lab automation

Topics

Resources

Contributing

Stars

524 stars

Watchers

14 watching

Forks

Releases

Packages

Used by

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Repository files navigation

What is PyLabRobot?

PyLabRobot is a hardware agnostic, pure Python library for liquid handling robots, plate readers, pumps, scales, heater shakers, and other lab automation equipment. Read the paper in Device.

Advantages over proprietary software:

  • Cross-platform: PyLabRobot works on Windows, macOS, and Linux. Many other interfaces are Windows-only.
  • Universal: PyLabRobot works with any supported liquid handling robot, plate reader, pump, scale, heater shaker, etc. through a single interface.
  • Fast iteration: PyLabRobot enables rapid development of protocols using atomic commands run interactively in Jupyter notebooks or the Python REPL. This decreases iteration time from minutes to seconds.
  • Open-source: PyLabRobot is open-source and free to use.
  • Control: With Python, you have ultimate flexibility to control your lab automation equipment. You can write Turing-complete protocols that include feedback loops.
  • Modern: PyLabRobot is built on modern Python 3.9+ features and async/await syntax.
  • Fast support: PyLabRobot has an active community forum for support and discussion, and most pull requests are merged within a day.

Liquid handling robots (docs)

PyLabRobot enables the use of any liquid handling robot through a single universal interface, that works on any modern operating system (Windows, macOS, Linux). We currently support Hamilton STAR, Hamilton Vantage, Tecan Freedom EVO, and Opentrons OT-2 robots, but we will soon support many more.

Here's a quick example showing how to move 100uL of liquid from well A1 to A2 using firmware on Hamilton STAR (this will work on any operating system!):

frompylabrobot.liquid_handlingimportLiquidHandlerfrompylabrobot.liquid_handling.backendsimportSTARBackendfrompylabrobot.resourcesimportDeckdeck=Deck.load_from_json_file("hamilton-layout.json")
lh=LiquidHandler(backend=STARBackend(), deck=deck)
awaitlh.setup()
awaitlh.pick_up_tips(lh.deck.get_resource("tip_rack")["A1"])
awaitlh.aspirate(lh.deck.get_resource("plate")["A1"], vols=100)
awaitlh.dispense(lh.deck.get_resource("plate")["A2"], vols=100)
awaitlh.return_tips()

To run the same protocol on an Opentrons, use the following:

frompylabrobot.liquid_handling.backendsimportOpentronsOT2Backenddeck=Deck.load_from_json_file("opentrons-layout.json")
lh=LiquidHandler(backend=OpentronsOT2Backend(host="x.x.x.x"), deck=deck)

Or Tecan (also works on any operating system!):

frompylabrobot.liquid_handling.backendsimportEVOBackenddeck=Deck.load_from_json_file("tecan-layout.json")
lh=LiquidHandler(backend=EVOBackend(), deck=deck)

We also provide a browser-based Visualizer which can visualize the state of the deck during a run, and can be used to develop and test protocols without a physical robot.

Visualizer

Plate readers (docs)

Moving a plate to a ClarioStar using a liquid handler, and reading luminescence:

frompylabrobot.plate_readingimportPlateReader, CLARIOstarBackendpr=PlateReader(name="plate reader", backend=CLARIOstarBackend(), size_x=1, size_y=1, size_z=1)
awaitpr.setup()
# Use in combination with a liquid handlerlh.assign_child_resource(pr, location=Coordinate(x, y, z))
lh.move_plate(lh.deck.get_resource("plate"), pr)
data=awaitpr.read_luminescence()

For Cytation5, use the Cytation5 backend.

Centrifuges (docs)

Centrifugation at 800g for 60 seconds with an Agilent VSpin:

frompylabrobot.centrifugeimportCentrifuge, VSpinBackendvspin_backend=VSpinBackend(device_id="YOUR_FTDI_ID_HERE")
cf=Centrifuge(name="centrifuge", backend=vspin_backend, size_x=1, size_y=1, size_z=1)
awaitcf.setup()
awaitcf.spin(g=800, duration=60)

For a HighRes Biosolutions MicroSpin, use the MicroSpin factory:

frompylabrobot.centrifugeimportMicroSpincf=MicroSpin(name="microspin", host="192.168.127.60")
awaitcf.setup()
awaitcf.backend.home()
awaitcf.spin(g=800, duration=60)

Pumps (docs)

Pumping at 100 rpm for 30 seconds using a Masterflex pump:

frompylabrobot.pumpsimportPumpfrompylabrobot.pumps.cole_parmer.masterfleximportMasterflexp=Pump(backend=Masterflex())
awaitp.setup()
awaitp.run_for_duration(speed=100, duration=30)

Scales (docs)

Taking a measurement from a Mettler Toledo scale:

frompylabrobot.mettler_toledoimportMTSICSDriverscale=MTSICSDriver(port="/dev/cu.usbserial-110")
awaitscale.setup()
weight=awaitscale.read_weight()

Heater shakers (docs)

Setting the temperature of a heater shaker to 37°C:

frompylabrobot.heating_shakingimportHeaterShaker, InhecoThermoShakeBackendbackend=InhecoThermoShakeBackend()
hs=HeaterShaker(backend=backend, name="HeaterShaker", size_x=0, size_y=0, size_z=0)
awaiths.setup()
awaiths.set_temperature(37)

Fans (docs)

Running a fan at 100% intensity for one minute:

frompylabrobot.only_fansimportFanfrompylabrobot.only_fansimportHamiltonHepaFanBackendfan=Fan(backend=HamiltonHepaFanBackend(), name="my fan")
awaitfan.setup()
awaitfan.turn_on(intensity=100, duration=60)

Thermocyclers (docs)

Running a thermocycler with a simple protocol:

awaittc.run_pcr_profile(
denaturation_temp=98.0,
denaturation_time=10.0,
annealing_temp=55.0,
annealing_time=30.0,
extension_temp=72.0,
extension_time=60.0,
num_cycles=2,
block_max_volume=25.0,
lid_temperature=105.0,
pre_denaturation_temp=95.0,
pre_denaturation_time=180.0,
final_extension_temp=72.0,
final_extension_time=300.0,
storage_temp=4.0,
storage_time=600.0,
)

Resources

Documentation

docs.pylabrobot.org

Support

Citing

If you use PyLabRobot in your research, please cite the following:

@article{WIERENGA2023100111,
title = {PyLabRobot: An open-source, hardware-agnostic interface for liquid-handling robots and accessories},
journal = {Device},
volume = {1},
number = {4},
pages = {100111},
year = {2023},
issn = {2666-9986},
doi = {https://doi.org/10.1016/j.device.2023.100111},
url = {https://www.sciencedirect.com/science/article/pii/S2666998623001709},
author = {Rick P. Wierenga and Stefan M. Golas and Wilson Ho and Connor W. Coley and Kevin M. Esvelt},
keywords = {laboratory automation, open source, standardization, liquid-handling robots},
}

Disclaimer: PyLabRobot is not officially endorsed or supported by any robot manufacturer. If you use a firmware driver such as the STAR driver provided here, you do so at your own risk. Usage of a firmware driver such as STAR may invalidate your warranty. Please contact us with any questions.

Developed for the Sculpting Evolution Group at the MIT Media Lab

About

interactive & hardware agnostic SDK for lab automation

Topics

Resources

Contributing

Stars

524 stars

Watchers

14 watching

Forks

Releases

Packages

Used by

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Repository files navigation

What is PyLabRobot?

PyLabRobot is a hardware agnostic, pure Python library for liquid handling robots, plate readers, pumps, scales, heater shakers, and other lab automation equipment. Read the paper in Device.

Advantages over proprietary software:

  • Cross-platform: PyLabRobot works on Windows, macOS, and Linux. Many other interfaces are Windows-only.
  • Universal: PyLabRobot works with any supported liquid handling robot, plate reader, pump, scale, heater shaker, etc. through a single interface.
  • Fast iteration: PyLabRobot enables rapid development of protocols using atomic commands run interactively in Jupyter notebooks or the Python REPL. This decreases iteration time from minutes to seconds.
  • Open-source: PyLabRobot is open-source and free to use.
  • Control: With Python, you have ultimate flexibility to control your lab automation equipment. You can write Turing-complete protocols that include feedback loops.
  • Modern: PyLabRobot is built on modern Python 3.9+ features and async/await syntax.
  • Fast support: PyLabRobot has an active community forum for support and discussion, and most pull requests are merged within a day.

Liquid handling robots (docs)

PyLabRobot enables the use of any liquid handling robot through a single universal interface, that works on any modern operating system (Windows, macOS, Linux). We currently support Hamilton STAR, Hamilton Vantage, Tecan Freedom EVO, and Opentrons OT-2 robots, but we will soon support many more.

Here's a quick example showing how to move 100uL of liquid from well A1 to A2 using firmware on Hamilton STAR (this will work on any operating system!):

frompylabrobot.liquid_handlingimportLiquidHandlerfrompylabrobot.liquid_handling.backendsimportSTARBackendfrompylabrobot.resourcesimportDeckdeck=Deck.load_from_json_file("hamilton-layout.json")
lh=LiquidHandler(backend=STARBackend(), deck=deck)
awaitlh.setup()
awaitlh.pick_up_tips(lh.deck.get_resource("tip_rack")["A1"])
awaitlh.aspirate(lh.deck.get_resource("plate")["A1"], vols=100)
awaitlh.dispense(lh.deck.get_resource("plate")["A2"], vols=100)
awaitlh.return_tips()

To run the same protocol on an Opentrons, use the following:

frompylabrobot.liquid_handling.backendsimportOpentronsOT2Backenddeck=Deck.load_from_json_file("opentrons-layout.json")
lh=LiquidHandler(backend=OpentronsOT2Backend(host="x.x.x.x"), deck=deck)

Or Tecan (also works on any operating system!):

frompylabrobot.liquid_handling.backendsimportEVOBackenddeck=Deck.load_from_json_file("tecan-layout.json")
lh=LiquidHandler(backend=EVOBackend(), deck=deck)

We also provide a browser-based Visualizer which can visualize the state of the deck during a run, and can be used to develop and test protocols without a physical robot.

Visualizer

Plate readers (docs)

Moving a plate to a ClarioStar using a liquid handler, and reading luminescence:

frompylabrobot.plate_readingimportPlateReader, CLARIOstarBackendpr=PlateReader(name="plate reader", backend=CLARIOstarBackend(), size_x=1, size_y=1, size_z=1)
awaitpr.setup()
# Use in combination with a liquid handlerlh.assign_child_resource(pr, location=Coordinate(x, y, z))
lh.move_plate(lh.deck.get_resource("plate"), pr)
data=awaitpr.read_luminescence()

For Cytation5, use the Cytation5 backend.

Centrifuges (docs)

Centrifugation at 800g for 60 seconds with an Agilent VSpin:

frompylabrobot.centrifugeimportCentrifuge, VSpinBackendvspin_backend=VSpinBackend(device_id="YOUR_FTDI_ID_HERE")
cf=Centrifuge(name="centrifuge", backend=vspin_backend, size_x=1, size_y=1, size_z=1)
awaitcf.setup()
awaitcf.spin(g=800, duration=60)

For a HighRes Biosolutions MicroSpin, use the MicroSpin factory:

frompylabrobot.centrifugeimportMicroSpincf=MicroSpin(name="microspin", host="192.168.127.60")
awaitcf.setup()
awaitcf.backend.home()
awaitcf.spin(g=800, duration=60)

Pumps (docs)

Pumping at 100 rpm for 30 seconds using a Masterflex pump:

frompylabrobot.pumpsimportPumpfrompylabrobot.pumps.cole_parmer.masterfleximportMasterflexp=Pump(backend=Masterflex())
awaitp.setup()
awaitp.run_for_duration(speed=100, duration=30)

Scales (docs)

Taking a measurement from a Mettler Toledo scale:

frompylabrobot.mettler_toledoimportMTSICSDriverscale=MTSICSDriver(port="/dev/cu.usbserial-110")
awaitscale.setup()
weight=awaitscale.read_weight()

Heater shakers (docs)

Setting the temperature of a heater shaker to 37°C:

frompylabrobot.heating_shakingimportHeaterShaker, InhecoThermoShakeBackendbackend=InhecoThermoShakeBackend()
hs=HeaterShaker(backend=backend, name="HeaterShaker", size_x=0, size_y=0, size_z=0)
awaiths.setup()
awaiths.set_temperature(37)

Fans (docs)

Running a fan at 100% intensity for one minute:

frompylabrobot.only_fansimportFanfrompylabrobot.only_fansimportHamiltonHepaFanBackendfan=Fan(backend=HamiltonHepaFanBackend(), name="my fan")
awaitfan.setup()
awaitfan.turn_on(intensity=100, duration=60)

Thermocyclers (docs)

Running a thermocycler with a simple protocol:

awaittc.run_pcr_profile(
denaturation_temp=98.0,
denaturation_time=10.0,
annealing_temp=55.0,
annealing_time=30.0,
extension_temp=72.0,
extension_time=60.0,
num_cycles=2,
block_max_volume=25.0,
lid_temperature=105.0,
pre_denaturation_temp=95.0,
pre_denaturation_time=180.0,
final_extension_temp=72.0,
final_extension_time=300.0,
storage_temp=4.0,
storage_time=600.0,
)

Resources

Documentation

docs.pylabrobot.org

Support

Citing

If you use PyLabRobot in your research, please cite the following:

@article{WIERENGA2023100111,
title = {PyLabRobot: An open-source, hardware-agnostic interface for liquid-handling robots and accessories},
journal = {Device},
volume = {1},
number = {4},
pages = {100111},
year = {2023},
issn = {2666-9986},
doi = {https://doi.org/10.1016/j.device.2023.100111},
url = {https://www.sciencedirect.com/science/article/pii/S2666998623001709},
author = {Rick P. Wierenga and Stefan M. Golas and Wilson Ho and Connor W. Coley and Kevin M. Esvelt},
keywords = {laboratory automation, open source, standardization, liquid-handling robots},
}

Disclaimer: PyLabRobot is not officially endorsed or supported by any robot manufacturer. If you use a firmware driver such as the STAR driver provided here, you do so at your own risk. Usage of a firmware driver such as STAR may invalidate your warranty. Please contact us with any questions.

Developed for the Sculpting Evolution Group at the MIT Media Lab

About

interactive & hardware agnostic SDK for lab automation

Topics

Resources

Contributing

Stars

524 stars

Watchers

14 watching

Forks

Releases

Packages

Used by

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content

Repository files navigation

What is PyLabRobot?

PyLabRobot is a hardware agnostic, pure Python library for liquid handling robots, plate readers, pumps, scales, heater shakers, and other lab automation equipment. Read the paper in Device.

Advantages over proprietary software:

  • Cross-platform: PyLabRobot works on Windows, macOS, and Linux. Many other interfaces are Windows-only.
  • Universal: PyLabRobot works with any supported liquid handling robot, plate reader, pump, scale, heater shaker, etc. through a single interface.
  • Fast iteration: PyLabRobot enables rapid development of protocols using atomic commands run interactively in Jupyter notebooks or the Python REPL. This decreases iteration time from minutes to seconds.
  • Open-source: PyLabRobot is open-source and free to use.
  • Control: With Python, you have ultimate flexibility to control your lab automation equipment. You can write Turing-complete protocols that include feedback loops.
  • Modern: PyLabRobot is built on modern Python 3.9+ features and async/await syntax.
  • Fast support: PyLabRobot has an active community forum for support and discussion, and most pull requests are merged within a day.

Liquid handling robots (docs)

PyLabRobot enables the use of any liquid handling robot through a single universal interface, that works on any modern operating system (Windows, macOS, Linux). We currently support Hamilton STAR, Hamilton Vantage, Tecan Freedom EVO, and Opentrons OT-2 robots, but we will soon support many more.

Here's a quick example showing how to move 100uL of liquid from well A1 to A2 using firmware on Hamilton STAR (this will work on any operating system!):

frompylabrobot.liquid_handlingimportLiquidHandlerfrompylabrobot.liquid_handling.backendsimportSTARBackendfrompylabrobot.resourcesimportDeckdeck=Deck.load_from_json_file("hamilton-layout.json")
lh=LiquidHandler(backend=STARBackend(), deck=deck)
awaitlh.setup()
awaitlh.pick_up_tips(lh.deck.get_resource("tip_rack")["A1"])
awaitlh.aspirate(lh.deck.get_resource("plate")["A1"], vols=100)
awaitlh.dispense(lh.deck.get_resource("plate")["A2"], vols=100)
awaitlh.return_tips()

To run the same protocol on an Opentrons, use the following:

frompylabrobot.liquid_handling.backendsimportOpentronsOT2Backenddeck=Deck.load_from_json_file("opentrons-layout.json")
lh=LiquidHandler(backend=OpentronsOT2Backend(host="x.x.x.x"), deck=deck)

Or Tecan (also works on any operating system!):

frompylabrobot.liquid_handling.backendsimportEVOBackenddeck=Deck.load_from_json_file("tecan-layout.json")
lh=LiquidHandler(backend=EVOBackend(), deck=deck)

We also provide a browser-based Visualizer which can visualize the state of the deck during a run, and can be used to develop and test protocols without a physical robot.

Visualizer

Plate readers (docs)

Moving a plate to a ClarioStar using a liquid handler, and reading luminescence:

frompylabrobot.plate_readingimportPlateReader, CLARIOstarBackendpr=PlateReader(name="plate reader", backend=CLARIOstarBackend(), size_x=1, size_y=1, size_z=1)
awaitpr.setup()
# Use in combination with a liquid handlerlh.assign_child_resource(pr, location=Coordinate(x, y, z))
lh.move_plate(lh.deck.get_resource("plate"), pr)
data=awaitpr.read_luminescence()

For Cytation5, use the Cytation5 backend.

Centrifuges (docs)

Centrifugation at 800g for 60 seconds with an Agilent VSpin:

frompylabrobot.centrifugeimportCentrifuge, VSpinBackendvspin_backend=VSpinBackend(device_id="YOUR_FTDI_ID_HERE")
cf=Centrifuge(name="centrifuge", backend=vspin_backend, size_x=1, size_y=1, size_z=1)
awaitcf.setup()
awaitcf.spin(g=800, duration=60)

For a HighRes Biosolutions MicroSpin, use the MicroSpin factory:

frompylabrobot.centrifugeimportMicroSpincf=MicroSpin(name="microspin", host="192.168.127.60")
awaitcf.setup()
awaitcf.backend.home()
awaitcf.spin(g=800, duration=60)

Pumps (docs)

Pumping at 100 rpm for 30 seconds using a Masterflex pump:

frompylabrobot.pumpsimportPumpfrompylabrobot.pumps.cole_parmer.masterfleximportMasterflexp=Pump(backend=Masterflex())
awaitp.setup()
awaitp.run_for_duration(speed=100, duration=30)

Scales (docs)

Taking a measurement from a Mettler Toledo scale:

frompylabrobot.mettler_toledoimportMTSICSDriverscale=MTSICSDriver(port="/dev/cu.usbserial-110")
awaitscale.setup()
weight=awaitscale.read_weight()

Heater shakers (docs)

Setting the temperature of a heater shaker to 37°C:

frompylabrobot.heating_shakingimportHeaterShaker, InhecoThermoShakeBackendbackend=InhecoThermoShakeBackend()
hs=HeaterShaker(backend=backend, name="HeaterShaker", size_x=0, size_y=0, size_z=0)
awaiths.setup()
awaiths.set_temperature(37)

Fans (docs)

Running a fan at 100% intensity for one minute:

frompylabrobot.only_fansimportFanfrompylabrobot.only_fansimportHamiltonHepaFanBackendfan=Fan(backend=HamiltonHepaFanBackend(), name="my fan")
awaitfan.setup()
awaitfan.turn_on(intensity=100, duration=60)

Thermocyclers (docs)

Running a thermocycler with a simple protocol:

awaittc.run_pcr_profile(
denaturation_temp=98.0,
denaturation_time=10.0,
annealing_temp=55.0,
annealing_time=30.0,
extension_temp=72.0,
extension_time=60.0,
num_cycles=2,
block_max_volume=25.0,
lid_temperature=105.0,
pre_denaturation_temp=95.0,
pre_denaturation_time=180.0,
final_extension_temp=72.0,
final_extension_time=300.0,
storage_temp=4.0,
storage_time=600.0,
)

Resources

Documentation

docs.pylabrobot.org

Support

Citing

If you use PyLabRobot in your research, please cite the following:

@article{WIERENGA2023100111,
title = {PyLabRobot: An open-source, hardware-agnostic interface for liquid-handling robots and accessories},
journal = {Device},
volume = {1},
number = {4},
pages = {100111},
year = {2023},
issn = {2666-9986},
doi = {https://doi.org/10.1016/j.device.2023.100111},
url = {https://www.sciencedirect.com/science/article/pii/S2666998623001709},
author = {Rick P. Wierenga and Stefan M. Golas and Wilson Ho and Connor W. Coley and Kevin M. Esvelt},
keywords = {laboratory automation, open source, standardization, liquid-handling robots},
}

Disclaimer: PyLabRobot is not officially endorsed or supported by any robot manufacturer. If you use a firmware driver such as the STAR driver provided here, you do so at your own risk. Usage of a firmware driver such as STAR may invalidate your warranty. Please contact us with any questions.

Developed for the Sculpting Evolution Group at the MIT Media Lab

About

interactive & hardware agnostic SDK for lab automation

Topics

Resources

Contributing

Stars

524 stars

Watchers

14 watching

Forks

Releases

Packages

Used by

Contributors

Languages