Kmeggie+Veritas AI

DOCUMENTATION

Run the current prototype locally.

This quickstart runs the website and local QC workspace from the Kmeggie+ source project. FASTQ analysis and report import run in your browser.

01 / REQUIREMENTS

Before you begin

  • Node.js 22.13 or newer and Corepack with pnpm
  • Access to the kmeggie-plus-website source project
  • A local machine with enough space for the FASTQ files you intend to inspect

The source repository currently requires access. This site does not publish a public Python or CLI package.

02 / LOCAL QUICKSTART

Install and start the prototype

$ from the source project foldercd kmeggie-plus-website
corepack pnpm install --frozen-lockfile
corepack pnpm run build
corepack pnpm run dev

When the local server starts, open http://127.0.0.1:4173 in the same machine’s browser.

Current architecture note

The preview serves generated static pages. Rebuild after editing source files. QC calculations run in a browser Worker; the separate pilot API defaults to disabled. Local processing does not guarantee that the hosted website is available offline.

03 / NO-INSTALL DEMO

Use the website prototype

  1. Open the QC workspace.
  2. Run the 500-read synthetic sample or choose a supported local FASTQ file.
  3. Review validation checks, metrics, and charts.
  4. Export the report as HTML or JSON. Use Open JSON to reopen a saved report.
Open the live QC demo

04 / SUPPORTED INPUT

Prototype limits

Files .fastq, .fq, and gzip-compressed variants
Records Four-line, single-end FASTQ
Quality encoding Phred+33
Local input size 50 MB
Decompressed size 100 MB
Read count 200,000 reads
Read length 100,000 bases per read

Files above a limit are rejected rather than sampled. Duplicate reporting uses bounded sequence hashes. FastQC ZIP results preserve imported module statuses and available measurements; they are not re-run in the browser. Reports can be exported as HTML or JSON and reopened from JSON after schema validation. Adapter detection, paired-end validation, and classification are not included.

05 / RELEASE STATUS

What is published

PUBLICBrowser QC demoOpen →
DIRECT ACCESSWebsite source projectRepository access required
PENDINGPublic CLI packageNo pip install kmeggie claim yet
PENDINGPublic CLI source repositoryLink will appear after publication