Biohit Pipettor Plus Documentation
====================================

Welcome to the Biohit Pipettor Plus documentation. This is a modern GUI application
for controlling electronic pipettors with advanced workflow capabilities.

Quick Links
-----------

* `Download Latest Release <https://github.com/smartlab-network/open-biohit-gui/releases/latest>`_
* `GitHub Repository <https://github.com/smartlab-network/open-biohit-gui>`_

Working Tutorial
------------------

.. youtube:: gM6Kxg_iGMc
   :width: 800
   :height: 450

Overview
--------

Biohit Pipettor GUI is a comprehensive solution for automated pipetting operations.
While currently in use with Biohit electronic pipettors, it can be adapted for use
with other pipettor brands as well.

Key Features
^^^^^^^^^^^^

* **Interactive GUI** - Custom deck, slot, and labware definition with easy visualization
* **Flexible** - Works with both single and multi-channel pipettors
* **Direct Operations** - Direct implementation of operations like pick_tips, return_tips,etc
* **Workflow Builder** - Build, save, and run complex operation sequences
* **Operation Logging** - Complete tracking of all pipetting operations
* **Save & Load** - Persistent storage of workflows and deck configurations

User Guide
----------
For understanding Graphical User Interface (GUI) and its backend code

.. toctree::
   :maxdepth: 1
   :caption: Contents

   deck_slot_labware
   howtocreateadeck
   pipettor
   operation
   workflow
   troubleshooting
   api.rst

Installation Guide
-------------------------

The package can be installed from PyPI using a virtual environment with **Python (3.10-3.13) (32-bit)**.
example python3.10. `Download Python 3.10 (32-bit) <https://www.python.org/downloads/release/python-3100/>`_

**Windows**

.. code-block:: bash

   py -3.10 -m venv .venv
   .venv\Scripts\activate
   python -m pip install --upgrade pip
   pip install open-biohit-gui
   pipettor-gui

**macOS / Linux**

.. code-block:: bash

   python3.10 -m venv .venv
   source .venv/bin/activate
   python -m pip install --upgrade pip
   pip install open-biohit-gui
   pipettor-gui

.. note::

   Command syntax may vary slightly depending on your system configuration.
   On macOS, you may need to set the following environment variables before running:

.. code-block:: bash

  export PYTHONNET_RUNTIME=coreclr
  export DYLD_LIBRARY_PATH=/usr/local/share/dotnet:$DYLD_LIBRARY_PATH
  pipettor-gui

Install from GitHub (Advanced)
-------------------------------

For developers who want to contribute or run the latest unreleased code:

.. code-block:: bash

   git clone https://github.com/smartlab-network/open-biohit-gui.git
   cd open-biohit-gui
   python3.10 -m venv .venv
   source .venv/bin/activate        # On Windows: .venv\Scripts\activate
   pip install -e .
   pipettor-gui

The main entry point is ``pipettor-gui``, which launches the GUI directly.
For macOS, PYTHONNET_RUNTIME set up (as shown above) might be required

Support
-------

If you encounter any issues or have questions:

* Check the :doc:`troubleshooting` guide
* Open an issue on `GitHub <https://github.com/smartlab-network/open-biohit-gui/issues>`_

Indices and Tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`