Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .github/actions/run-tests/action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,10 @@ runs:
- name: Update packages
run: sudo apt-get update
shell: bash
- name: Install BTX OCR system dependency
if: ${{ inputs.extra == 'btx' || inputs.extra == 'all' }}
run: sudo apt-get install -y tesseract-ocr
shell: bash
- name: Set up Python
uses: actions/setup-python@v6
with:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ jobs:
fail-fast: false
matrix:
os: [ubuntu-latest]
extra: ["<none>", serial, usb, ftdi, hid, modbus, opentrons, sila, cytation-microscopy, pico]
extra: ["<none>", serial, usb, ftdi, hid, btx, modbus, opentrons, sila, cytation-microscopy, pico]

name: Tests (${{ matrix.extra }}, py3.12)
runs-on: ${{ matrix.os }}
Expand Down
12 changes: 11 additions & 1 deletion docs/_static/devices.json
Original file line number Diff line number Diff line change
Expand Up @@ -441,6 +441,16 @@
"docs": "/user_guide/01_material-handling/sealers/a4s.html",
"oem": "https://www.azenta.com/products/automated-roll-heat-sealer-formerly-a4s"
},
{
"vendor": "BTX",
"name": "Gemini X2",
"capabilities": [
"electroporation"
],
"status": "Mostly",
"docs": "/user_guide/btx/gemini_x2/hello-world.html",
"oem": "https://support.btxonline.com/hc/en-us/articles/6215664757907-Gemini-Twin-Wave-Electroporators-Manual-and-Quick-Start-guide"
},
{
"vendor": "Opentrons",
"name": "Thermocycler",
Expand Down Expand Up @@ -687,4 +697,4 @@
"docs": "/user_guide/02_analytical/scales.html#mettler-toledo-wxs205sdu",
"oem": "https://www.mt.com/us/en/home/products/Industrial_Weighing_Solutions/high-precision-weigh-sensors/weigh-module-wxs205sdu-15-11121008.html"
}
]
]
45 changes: 45 additions & 0 deletions docs/api/pylabrobot.btx.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
.. currentmodule:: pylabrobot.btx

pylabrobot.btx package
======================

Gemini X2
---------

.. currentmodule:: pylabrobot.btx.gemini_x2

.. autosummary::
:toctree: _autosummary
:nosignatures:
:recursive:

BTXGeminiX2
BTXGeminiX2Driver
BTXGeminiX2ElectroporationBackend

.. currentmodule:: pylabrobot.btx.file_transfer_control

.. autosummary::
:toctree: _autosummary
:nosignatures:
:recursive:

FileTransferControl

.. currentmodule:: pylabrobot.btx.the_ghost_touch

.. autosummary::
:toctree: _autosummary
:nosignatures:
:recursive:

TheGhostTouch

.. currentmodule:: pylabrobot.btx.ht200

.. autosummary::
:toctree: _autosummary
:nosignatures:
:recursive:

BTXHT200
47 changes: 43 additions & 4 deletions docs/api/pylabrobot.capabilities.rst
Original file line number Diff line number Diff line change
Expand Up @@ -220,6 +220,45 @@ Automated Retrieval
AutomatedRetrievalBackend


Electroporation
---------------

.. currentmodule:: pylabrobot.capabilities.electroporation.electroporation

.. autosummary::
:toctree: _autosummary
:nosignatures:
:recursive:

Electroporation

.. currentmodule:: pylabrobot.capabilities.electroporation.backend

.. autosummary::
:toctree: _autosummary
:nosignatures:
:recursive:

ElectroporationBackend

.. currentmodule:: pylabrobot.capabilities.electroporation.standard

.. autosummary::
:toctree: _autosummary
:nosignatures:
:recursive:

ElectroporationProtocol
PreparedElectroporationRun
ElectroporationRunResult
ElectroporationCancellationResult
ElectroporationPreparationDetails
ElectroporationExecutionDetails
ElectroporationCancellationDetails
ElectroporationLogCapture
ElectroporationCleanup


Plate Reading - Absorbance
--------------------------

Expand Down Expand Up @@ -287,7 +326,7 @@ Devices
Bulk Dispensing - Peristaltic
-----------------------------

.. currentmodule:: pylabrobot.capabilities.bulk_dispensers.peristaltic.peristaltic
.. currentmodule:: pylabrobot.capabilities.bulk_dispensers.peristaltic.peristaltic8

.. autosummary::
:toctree: _autosummary
Expand All @@ -296,7 +335,7 @@ Bulk Dispensing - Peristaltic

PeristalticDispensing8

.. currentmodule:: pylabrobot.capabilities.bulk_dispensers.peristaltic.backend
.. currentmodule:: pylabrobot.capabilities.bulk_dispensers.peristaltic.backend8

.. autosummary::
:toctree: _autosummary
Expand All @@ -309,7 +348,7 @@ Bulk Dispensing - Peristaltic
Bulk Dispensing - Syringe
-------------------------

.. currentmodule:: pylabrobot.capabilities.bulk_dispensers.syringe.syringe
.. currentmodule:: pylabrobot.capabilities.bulk_dispensers.syringe.syringe8

.. autosummary::
:toctree: _autosummary
Expand All @@ -318,7 +357,7 @@ Bulk Dispensing - Syringe

SyringeDispensing8

.. currentmodule:: pylabrobot.capabilities.bulk_dispensers.syringe.backend
.. currentmodule:: pylabrobot.capabilities.bulk_dispensers.syringe.backend8

.. autosummary::
:toctree: _autosummary
Expand Down
1 change: 1 addition & 0 deletions docs/api/pylabrobot.rst
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ Manufacturers
pylabrobot.azenta
pylabrobot.bmg_labtech
pylabrobot.brooks
pylabrobot.btx
pylabrobot.byonoy
pylabrobot.hamilton
pylabrobot.inheco
Expand Down
14 changes: 14 additions & 0 deletions docs/user_guide/_getting-started/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@ Different machines use different communication modes. Replace `[usb]` with one o
| `usb` | pyusb, libusb-package | USB devices: e.g. Hamilton STAR/STARlet, Tecan EVO (firmware) |
| `ftdi` | pylibftdi, pyusb | FTDI devices: e.g. BioTek Synergy H1 plate reader |
| `hid` | hid | HID devices: e.g. Inheco Incubator/Shaker (HID mode) |
| `btx` | pyserial, numpy, Pillow | BTX Gemini X2 electroporator |
| `modbus` | pymodbus | Modbus devices: e.g. Agrow Pump Array |
| `opentrons` | opentrons-http-api-client | e.g. Opentrons backend |
| `cytation-microscopy` | numpy (1.26), opencv-python | Cytation imager |
Expand Down Expand Up @@ -171,6 +172,19 @@ If you get a `usb.core.NoBackendError: No backend available` error: [this](https

If you are still having trouble, please reach out on [discuss.pylabrobot.org](https://discuss.pylabrobot.org).

## BTX Gemini X2

The BTX Gemini X2 support uses serial communication and GhostTouch screenshot OCR. First, install
the Python dependencies:

```bash
pip install "pylabrobot[btx]"
```

GhostTouch also requires the external [Tesseract OCR](https://github.com/tesseract-ocr/tesseract)
executable. Install Tesseract for your operating system and make sure the `tesseract` command is
available on `PATH`.

## Cytation imager

In order to use imaging on the Cytation, you need to:
Expand Down
Loading
Loading