ExLab-Wizard documentation

ExLab-Wizard is a desktop tool that standardises lab run and project directory creation, NAS sync, and LIMS integration. The documentation is split into three trees:

Contents

• User Guide
  • Capability map
  • Conventions
• Plugin Author Guide
  • What plugins do
  • Where plugins fit in the pipeline
  • Where to look in the codebase
• API Reference
  • exlab_wizard.api
  • exlab_wizard.cache
  • exlab_wizard.config
  • exlab_wizard.controller
  • exlab_wizard.lims
  • exlab_wizard.orchestrator
  • exlab_wizard.plugins
  • exlab_wizard.readme
  • exlab_wizard.sync
  • exlab_wizard.template
  • exlab_wizard.tray
  • exlab_wizard.ui
  • exlab_wizard.validator
  • exlab_wizard.window
  • exlab_wizard.logging
  • exlab_wizard.errors

What is ExLab-Wizard

ExLab-Wizard runs as a small system-tray application backed by a FastAPI server and a NiceGUI frontend that the operator drives through a native window. Each new project or run is created via a guided wizard that enforces a consistent on-disk layout, captures a small set of mandatory metadata fields, and queues the result for sync to a shared NAS. The application is extensible through Python plugins that mutate files inside a freshly rendered run directory.

Where to start

• Operators should begin in the User Guide. Every user-visible capability has a dedicated page with screenshots generated from the live test surface.

• Plugin authors should read Plugin Author Guide. The guide mirrors the design specification and links to the worked example shipped under exlab_wizard/plugins/.

• Developers extending the application should consult API Reference, which exposes the full autosummary tree across every public subsystem.

Project metadata

Item	Value
Package version	{{ release }}
Python target	3.12
Repository	github.com/ExFAB/ExLabWizard