Skip to content

README: the Masterflex and ThermoShake examples use their v1 drivers - #1615

Closed
sriramdevadas wants to merge 1 commit into
PyLabRobot:mainfrom
sriramdevadas:fix/readme-broken-examples
Closed

sriramdevadas wants to merge 1 commit into
PyLabRobot:mainfrom
sriramdevadas:fix/readme-broken-examples

Conversation

@sriramdevadas

Copy link
Copy Markdown
Contributor

The Problem

Two README.md examples fail at import on main:

  • Pumps: from pylabrobot.pumps.cole_parmer.masterflex import Masterflex raises ModuleNotFoundError: No module named 'pylabrobot.pumps.cole_parmer'.
  • Heater shakers: from pylabrobot.heating_shaking import HeaterShaker, InhecoThermoShakeBackend raises ImportError: cannot import name 'InhecoThermoShakeBackend'.

PR Content

  • Pumps: the v1 pylabrobot.cole_parmer.Masterflex, with run_continuously(speed=100), a 30 s wait and halt(), the run, wait and halt that Pump.run_for_duration describes.
  • Heater shakers: an InhecoTECControlBox and inheco_thermoshake(..., index=1), set up as in the ThermoShake hello-world notebook, then set_temperature(37).

Open PR #1524 also edits these two blocks (it wraps them in async with) and leaves their imports as they are, so the second of the two to merge will have a small conflict in README.md.

Tests: docs only; no test reads README.md. Every README import resolves on this branch, and with the serial port and the HID device replaced by recorders the examples send S+100G0, H after the wait, 1STT370 and 1ATE1. The Unit Tests workflow passes on my fork on this commit (run).

🤖 Generated with Claude Code

The pump example opens a `Masterflex` on a serial port and runs it at
100 rpm for 30 s with `run_continuously` and `halt`. The heater shaker
example opens an `InhecoTECControlBox` and sets the ThermoShake at
index 1 to 37 °C.
@sriramdevadas
sriramdevadas requested a review from a team as a code owner November 11, 2026 21:36
@rickwierenga

Copy link
Copy Markdown
Member

thanks for the PR! there are actually many problems in the readme with the transition to v1. i think we should delete these examples for now since having them for every device is unwieldy. feel free to make a PR for that if you like :)

@sriramdevadas
sriramdevadas deleted the fix/readme-broken-examples branch November 11, 2026 21:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants