Karcytics API Reference (Auto-generated)

This page is autogenerated from the karcytics package using mkdocstrings. Update docstrings in source code; regenerate docs to apply changes.

Overview

This section provides API documentation grouped by logical subpackages so readers can quickly find relevant symbols.

Core

Karcytics Core — Configuration, history, module management, and plugin SDK.

Karcytics SDK (`karcytics_sdk`)

The shared package every plugin — and the Hub itself — depends on; see docs/internal/25_Core_and_SDK_Boundary.md for what lives here versus in karcytics.* above.

Karcytics SDK — Software Development Kit for Karcytics desktop plugins.

Provides two main namespaces

plugin: Clean API for plugin development with zero unnecessary dependencies.
host: Host-facing APIs for the Core application and SDK signing CLI.

Plugins & SDK helpers

Karcytics Plugins Namespace.

Shared utilities

Shared corefor karcytics package.

UI layer

Karcytics UI — Components, dialogs, dashboards, and windows.

Themes & assets

Karcytics themes and visual asset definitions.

Tutorials (code-driven)

Karcytics Core Tutorials package.

Contains the built-in onboarding and core-level tutorial courses that are registered on the "core" sentinel module ID. These courses are started programmatically by the WorkspaceWindow and do not appear in the per-module Academy catalogue.

Karcytics — Bio Analysis Made Simple.

A free, intuitive platform for lab students and professionals. Automates tedious bio analysis workflows through a modern desktop interface.

Modules:

Name	Description
`analysis`	Headless image processing engine (usable without GUI).
`ui`	PyQt6 desktop interface components.