ComfyLAB

KO | EN

gitlite — search

#markdown #http #nlp #openai #ai-agents #rust #linux #ai-agent #csharp #redis

(★ 9)

ComfyLAB (Comfortable Lab Automation Blocks) is a visual, block-based software platform for automating scientific and test & measurement laboratory experiments.

File Explorer

ZIP Download

- - __init__.py
  - blocks.py
  - diagnostics.py
  - execution.py
  - packages.py
  - settings.py
  - updates.py
  - workspace.py
- __init__.py
- adjectives.txt
- auth.py
- main.py
- manager.py
- nouns.txt
- ratelimit.py
- workspace.py
- - __init__.py
  - base.py
  - base_script.py
  - basic_math.py
  - cluster.py
  - cluster_boundary.py
  - constants.py
  - control_flow.py
  - dictionary.py
  - examples.py
  - external_com.py
  - external_library.py
  - io.py
  - lists.py
  - loader.py
  - logic.py
  - math_fit.py
  - math_functions.py
  - ndarrays.py
  - outputs_basic.py
  - plots.py
  - publisher.py
  - script.py
  - script_csharp.py
  - script_external_python.py
  - script_js.py
  - script_julia.py
  - script_lua.py
  - script_maxima.py
  - script_octave.py
  - script_powershell.py
  - script_r.py
  - script_rust.py
  - script_sage.py
  - script_wolfram.py
  - signal.py
  - strings.py
  - timing.py
  - utility.py
  - visa.py
- - bode_export_dataset.cluster.json
  - bode_measure_point.cluster.json
  - bode_measure_virtual_point.cluster.json
  - bode_setup_instruments.cluster.json
  - bode_setup_virtual_instruments.cluster.json
  - fh_accumulate_data.cluster.json
  - fh_check_limits.cluster.json
  - fh_export_dataset.cluster.json
  - fh_measure_point.cluster.json
  - fh_setup_instruments.cluster.json
  - vuv_accumulate_data.cluster.json
  - vuv_export_dataset.cluster.json
  - vuv_measure_point.cluster.json
  - vuv_setup_instruments.cluster.json
- - __init__.py
  - base.py
- - __init__.py
  - config.py
  - executor.py
  - locks.py
  - logging.py
  - models.py
  - registry.py
  - security.py
- - Bode_Diagram_Virtual.json
  - Bode_Plot_Example.json
  - Camera_Example.json
  - Continuous_Plot.json
  - Filtered_Data.json
  - Fit_Data.json
  - Horiba_H20_UVL_Spectroscopy.json
  - IFGW-F740_FranckHertz.json
  - Script_Example.json
  - SigGen_Osc_Example.json
  - Simple_Plot.json
  - VISA_Base_Example.json
- - __init__.py
  - manager.py
  - oscilloscope.py
  - rc_circuit.py
  - scpi_base.py
  - server.py
  - signal_generator.py
- __init__.py
- __main__.py
- cli.py
- Dockerfile.windows
- entrypoint.sh
- index.html
- example_1.png
- example_2.png
- landing_page.png
- - favicon.svg
  - icons.svg
- - App.css
  - App.tsx
  - i18n.ts
  - index.css
  - main.tsx
  - vite-env.d.ts
- __init__.py
- eslint.config.js
- index.html
- package.json
- tsconfig.app.json
- tsconfig.json
- tsconfig.node.json
- vite.config.ts
- __init__.py
- test_api.py
- test_cluster.py
- test_cluster_auth.py
- test_cluster_conflict.py
- test_device_library.py
- test_execution.py
- test_external_com.py
- test_external_library.py
- test_get_item_blocks.py
- test_horiba_blueprint.py
- test_locks.py
- test_logging.py
- test_multilang_script.py
- test_new_blocks.py
- test_new_devices.py
- test_new_standard_blocks.py
- test_packages.py
- test_parser.py
- test_persistence.py
- test_plots.py
- test_registry.py
- test_script.py
- test_security.py
- test_settings_and_publish.py
- test_updates.py
- test_virtual_instruments.py
- test_visa.py
- test_workspace.py
.gitignore
build_exe.py
build_release.py
build_windows_docker.sh
ComfyLAB.spec
LICENSE
MANIFEST.in
pyinstaller_entry.py
pyproject.toml
README.md
requirements.txt
start.bat
start.py
start.sh
VERSION

# Use via CDN

jsDelivr

jsDelivr serves any public GitHub repository as a CDN with zero setup. Pick a version and a file to get a ready-to-paste link and snippet.

Version

File

Link

Example

# Project Badges

Website Visit
PyPI version Visit
Python versions Visit
License: GPL v3 Visit

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

🌐 **Official Website & Interactive Showcase:** [https://gateeit-ifgw.github.io/ComfyLAB/](https://gateeit-ifgw.github.io/ComfyLAB/)

ComfyLAB (**Comf**ortable **L**ab **A**utomation **B**locks) is a visual, block-based software platform for automating scientific and test & measurement laboratory experiments. It allows researchers, students, and engineers to connect instruments, run analysis code, and view live plots using an intuitive drag-and-drop workspace.

> Developed and maintained by the **Electronics and Instrumentation team** from the **"Gleb Wataghin" Physics Institute (IFGW)** at the **University of Campinas (UNICAMP)**.

![ComfyLAB Main Interface](https://raw.githubusercontent.com/gateeit-ifgw/ComfyLAB/main/etc/landing_page.png)

---

## ✨ Features

- **Visual Block Programming**: Design automation procedures by connecting blocks together. No complex programming required.
- **Rich Block Library**: Extensive set of built-in blocks covering math, curve fitting, signal processing, array manipulation, control flow, file I/O, live plotting, instrument drivers, and utility functions.
- **Run Scripts in 13+ Languages & Native DLLs**: Run code blocks written in Python, Rust, C#, Julia, R, JavaScript, TypeScript, Lua, Octave, Maxima, Sage, Wolfram, or PowerShell, and bridge compiled C/C++ DLLs/.so or Windows ActiveX/COM controllers directly in your pipeline.
- **Equipment Control**: Connect and control physical laboratory hardware via VISA/SCPI protocol and dedicated instrument drivers.
- **Built-in Laboratory Safety**: If an automation run fails, is stopped, or encounters an error, ComfyLAB automatically triggers safety shutdown routines on instruments (e.g. turning off lasers or signal generator outputs) to protect your hardware.
- **Real-Time Live & Multi-Trace Graphs**: Stream data in real time with single and multi-trace live plotting widgets, custom axis limits, and persistent settings.
- **Whiteboard Canvas Overlay**: Draw diagrams, write notes, and add shapes directly on top of your workspace.
- **Custom Cluster Blocks**: Group a set of connected blocks into a single custom cluster block to keep your workspace clean and organized.
- **Security Protections**: Prevents untrusted blueprints from executing malicious scripts on your computer. You will be warned and asked for approval before running code from unknown sources.
- **Secure Remote Access**: Remotely access your lab setup PC running ComfyLAB, protected by a simple two-word token (user/password also available if needed).
- **Application Info & About Modal**: Access application details, license info, and versioning directly from the UI toolbar.

---

## 🚀 Getting Started

You can install and run ComfyLAB in multiple ways:

### Option 1: Install from PyPI (Quickest & Recommended)

Install ComfyLAB directly from PyPI via `pip`:

```bash
pip install comfylab
```

Then start the application from anywhere:

```bash
comfylab
```
*(or run via `python -m comfylab`)*

ComfyLAB will launch the backend server and automatically open the application in your default web browser.

---

### Option 2: Pre-compiled Releases (Run-Ready)

#### A. Standalone Single-File Binary (Zero-Dependency)
1. Download `ComfyLAB.exe` (Windows) or `ComfyLAB` (Linux/macOS) from the **GitHub Releases** page.
2. Launch the application:
   * **Windows**: Double-click `ComfyLAB.exe`.
   * **Linux / macOS**: Make it executable (`chmod +x ComfyLAB`) and run `./ComfyLAB` in a terminal.
3. Automatically opens in your default browser at `http://localhost:8000`.

#### B. Base Release Package (ZIP Archive)
1. Download the release `.zip` package from the **GitHub Releases** page and extract it.
2. Launch the application:
   * **Windows**: Double-click `start.bat`.
   * **Linux / macOS**: Run `bash start.sh` in terminal.
3. The bootstrapper script automatically initializes a local virtual environment, verifies dependencies, starts the backend, and opens your browser.

---

### Option 3: Running from Source (Developer Mode)
If you cloned the source code from GitHub:

1. Ensure you have **Python 3.10+** and **Node.js (npm)** installed.
2. Run the bootstrapper:
   * **Linux / macOS**: `bash start.sh`
   * **Windows**: Run `start.bat` in Command Prompt.
3. The bootstrapper will:
   * Initialize the local `.venv` environment and install Python requirements.
   * Run `npm install` inside `frontend/` if needed.
   * Launch the FastAPI backend (port `8000`) and the Vite dev server (port `5173`) concurrently with hot-reloading at `http://localhost:5173`.

---

### 🎛️ Command Line Options

You can customize the startup configuration with command-line flags (supported across `comfylab`, `python -m comfylab`, `start.sh`, and `start.bat`):

**Examples:**
```bash
# Run locally with lite visual mode on custom port
comfylab --local --port 8080 --lite

# Run via python module runner
python -m comfylab --host 0.0.0.0 --port 9000
```

---

## 🧩 Block Categories & Capabilities

ComfyLAB provides a rich, modular ecosystem of blocks for building automation workflows:

- **Math & Curve Fitting**: Basic arithmetic, trigonometric & logarithmic functions, polynomial, exponential, gaussian, and custom non-linear curve fitting.
- **Logic & Control Flow**: Boolean operations (AND, OR, NOT, XOR), comparisons, execution branches (If/Else), For/While loops, and sequential execution blocks.
- **Data Structures & Arrays**: Lists, Dictionaries, and multi-dimensional NDArrays (reshaping, slicing, linear algebra, statistics, and array-to-image conversion).
- **Signal Processing**: FFT & power spectral analysis, bandpass/lowpass/highpass filtering, detrending, windowing, and peak finding algorithms.
- **File I/O & Storage**: Read and write CSV files, JSON data, Parquet, and raw text files with automatic path resolution.
- **Visualization**: Interactive single and multi-trace line plots, scatter plots, and heatmaps/image viewers.
- **Instruments & VISA**: Direct VISA SCPI command/query execution and built-in drivers for oscilloscopes, signal generators, DMMs, optical spectrum analyzers, and power supplies.
- **Multi-Language Scripting**: Polyglot code execution blocks supporting 9 scripting languages (Python, Rust, JavaScript, TypeScript, Julia, R, Lua, Octave, Wolfram).
- **Clusters**: Group complex sub-graphs into custom reusable cluster blocks with dynamic input/output boundaries.
- **Utility & Timing**: Delays, timestamps, stopwatches, type conversion, console logging, and debugging inspectors.

---

## 📸 Example Workflows

| Experiment Automation Pipeline | Interactive Data Analysis & Plotting |
| :--- | :--- |
| ![ComfyLAB Example Workflow 1](https://raw.githubusercontent.com/gateeit-ifgw/ComfyLAB/main/etc/example_1.png) | ![ComfyLAB Example Workflow 2](https://raw.githubusercontent.com/gateeit-ifgw/ComfyLAB/main/etc/example_2.png) |

---

## 🏗️ Technical Architecture

The execution engine uses a **Hybrid State Machine (Push/Pull)** model inspired by game engine blueprints (such as Unreal Engine Blueprints), allowing cycles/loops and branches while retaining lazy evaluation of math/logic pipelines.

### 1. Push Wires (Execution Token)
* Defined by connections of type `exec` between `ExecOut` and `ExecIn` pins.
* Wires push an "Execution Token" forward, specifying state changes and the sequential execution order.
* Execution path loops (cycles) are natively supported for operations like `ForLoop`.

### 2. Pull Wires (Lazy Evaluation Data Bus)
* Defined by connections of type `data` between `DataOut` and `DataIn` pins.
* Calculated **on demand (lazy evaluation)** when an execution block pulls data.
* Calculation results are cached *within a single execution step* to prevent redundant recalculation. Caching is cleared between execution steps.

### 3. VISA Concurrency (ResourceLockManager)
* Automating hardware requires calling blocking VISA APIs. 
* To prevent conflicts when multiple blocks access the same physical hardware concurrently, the `ResourceLockManager` manages async locks mapping `VISA address -> asyncio.Lock`.
* Safely resolves resource contentions with timeout/watchdog support to prevent deadlocks.

---

## 📂 Project Structure

```
ComfyLAB/  (root)
├── pyproject.toml              # Modern PEP 517/518 packaging configuration (PyPI)
├── MANIFEST.in                 # Source distribution inclusion/exclusion rules
├── LICENSE                     # Software license (GPLv3)
├── README.md                   # This document
├── requirements.txt            # Python package dependencies
├── VERSION                     # Application version tracking
├── start.sh                    # Linux/macOS venv bootstrapper
├── start.bat                   # Windows venv bootstrapper
├── start.py                    # Cross-platform startup launcher (delegates to comfylab.cli)
├── pyinstaller_entry.py        # PyInstaller application entry point
├── build_exe.py                # Builds the standalone single-file executable
├── build_release.py            # Builds the release ZIP and PyPI wheel packages
├── ComfyLAB.spec               # PyInstaller spec (frozen core + external blocks)
├── backend/                    # FastAPI API routers & WebSockets server
├── comfylab/                   # Core Python Package & Execution Engine
│   ├── __main__.py             # Entry point for `python -m comfylab`
│   ├── cli.py                  # Unified CLI coordinator & argument handler
│   ├── engine/                 # Models, executor, lock manager, registry, security, config
│   ├── blocks/                 # Block protocol (base), category modules, scripts, VISA
│   ├── clusters/               # Built-in cluster sub-graph definitions
│   ├── devices/                # Extensible instrument driver modules
│   └── examples/               # Built-in example experiment workflows (.json)
├── frontend/                   # React + Vite + React Flow web UI
└── tests/                      # Automated pytest integration & unit tests
```

---

## 📦 Building Releases (For Developers)

ComfyLAB provides automated build scripts in the root directory to generate production distribution packages.

### 1. Build Portable ZIP Release Package
To compile the frontend and package a ready-to-run release `.zip`:
```bash
python3 build_release.py
# Optionally bump version before building:
python3 build_release.py --bump [patch|minor|major]
```

### 2. Build Standalone Single-File Executable
To compile the entire application into a single, zero-dependency executable (`ComfyLAB` or `ComfyLAB.exe`):
```bash
python3 build_exe.py
# Optionally bump version:
python3 build_exe.py --bump [patch|minor|major]
```

---

## 🧪 Running the Verification Suite
To execute all unit and integration tests:
```bash
python3 -m pytest tests/
```

---

## 🏛️ Development & Maintenance

ComfyLAB is developed and maintained by the **Electronics and Instrumentation team** from the **"Gleb Wataghin" Physics Institute (IFGW)** at the **University of Campinas (UNICAMP)**, Brazil.

---

## 📄 License

This project is licensed under the **GNU General Public License v3.0** - see the [LICENSE](LICENSE) file for details.

---

## 🤖 AI Assistance Disclosure

Portions of this codebase were developed with the assistance of AI coding tools. All design decisions, architecture, domain-specific logic, and final implementation choices were authored and reviewed by the project maintainer. AI tools were used as a productivity aid, in the same spirit as an IDE, a linter, or a documentation reference.

ComfyLAB

File Explorer

# Use via CDN

# Project Badges

Was this content helpful?

Recent Feedback

Download README