Skip to main content

Repository Documentation PyPI Package PyPI Downloads

Automator: automated imaging of round Petri dishes/plates for magnaporthe analysis.

Automator is an open-source system for real-time automated imaging, tracking, and analysis of round Petri dishes/plates (90–100 mm) containing magnaporthe Orzae, integrating motion control, camera acquisition, and scheduling on Raspberry Pi hardware using Klipper, Moonraker, and a custom Python-based controller and web interface.

This package is the installable distribution of the Automator controller and its reference assets — for the full source repository, contributor guidelines, and changelog, see https://github.com/rotsl/Automator.

Install on a new Raspberry Pi

1. System prerequisites (Raspberry Pi OS lite 64-bit)

sudo apt update
sudo apt install -y \
  python3 python3-venv python3-dev \
  libcamera-dev libcamera-apps v4l-utils \
  libjpeg-dev libpng-dev libatlas-base-dev

2. Create a virtual environment and install the package

python3 -m venv venv_clean
source venv_clean/bin/activate
pip install --upgrade pip
pip install automator-tsl[pi]

The [pi] extra pulls in the Raspberry-Pi-only hardware dependencies (picamera2, RPi.GPIO, gpiozero). Omit it if you're only inspecting the bundled documentation/templates on a non-Pi machine.

3. Fetch the plate-detection model

The YOLO ONNX model used for plate detection is not bundled in this package (to keep it small) — fetch it from Hugging Face after install:

automator-fetch-model

This downloads bestnew.onnx from rotsl/petri_dish_yolo and places it at ~/Automator/data/bestnew.onnx.

Integrity check: the download is verified against a pinned SHA-256 digest before being copied into place. If the file has been tampered with or the upstream model has changed unexpectedly, the command will exit with an error and remove the file automatically.

4. Generate security keys, configure Klipper/Moonraker, and start the controller

Follow the full installation steps in HandOver.md, then start the controller:

python -m dev2.maincontroller

Full documentation

The complete documentation site, including the step-by-step user guide, admin/maintainer handover, and run book, is published at:

https://rotsl.github.io/Automator/

In this package

Alongside the Python code, this package installs a copy of the project's reference assets under share/automator/ in your environment's install prefix:

  • share/automator/data/ — calibration.json (camera calibration reference)
  • share/automator/raw/ — runtime state directory (created empty on install)

License

This package bundles software (MIT License), hardware design references (CERN Open Hardware Licence v2 - Strongly Reciprocal), and documentation (CC BY 4.0). See LICENSE for the full breakdown by component, and LICENSE-MIT, LICENSE-CERN-OHL-S, LICENSE-CC-BY-4.0 for the individual license texts (all included with this package).

Recommended citation

@software{R_Automator_Automated_Imaging_20252026,
author = {R, Rohan},
title = {{Automator: Automated Imaging of Microbial Plates}},
url = {https://github.com/rotsl/Automator},
year = {2025–2026}
}

Institutional note

This package as part of the main repository represents research automation tooling developed at The Sainsbury Laboratory, Norwich.
It is provided as-is for research and engineering use and is not a certified laboratory instrument unless approved by the institute.

Users are responsible for:

  • validating the system for their experimental context
  • complying with local safety, electrical, and biological regulations
  • ensuring appropriate risk assessments are in place

🦠 Built for reproducible research automation.👨‍🔬

“Make the instrument part of the method.”

Metadata

Release files for automator-tsl 3.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for automator-tsl 3.0.0
File Size Uploaded
automator_tsl-3.0.0.tar.gz 2.5 MB Details

Built distribution (wheel)

Table of built distributions (wheels) for automator-tsl 3.0.0
File Interpreter ABI Platform
automator_tsl-3.0.0-py3-none-any.whl Python 3 none any Details

Total release size: 5.0 MB

Release files / automator_tsl-3.0.0.tar.gz

Download URL automator_tsl-3.0.0.tar.gz
Size 2.5 MB
Tags Source
SHA-256 checksum
How to use checksums
3a010dc0b4d85604369f6d933bbcf33ff8f91c06216d8ee02cf2670001babb4a
BLAKE2b-256 checksum
How to use checksums
4df60175e48b8026e4aa51e60d5da8102dfac2cfbddb3736cd7e799db1bbffc4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.13

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Jul 26, 2026.

Transparency log

Release files / automator_tsl-3.0.0-py3-none-any.whl

Download URL automator_tsl-3.0.0-py3-none-any.whl
Size 2.5 MB
Tags Python 3
SHA-256 checksum
How to use checksums
776669c804250c3680cb596c178b459f687fbfd549fc47c69b5804d919d9a950
BLAKE2b-256 checksum
How to use checksums
1aa54443995d7ecbd6e7278a2cbdc190c0840b7e3de1fcfbfcfafe97754df479
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.13

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Jul 26, 2026.

Transparency log

Release history Release notifications | RSS feed

This release

3.0.0 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page