Skip to content

About

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

Seq Design Buddy

Seq Design Buddy is a static beginner documentation hub for the SeqTrainer ecosystem. It explains four separate tools and the files that move between them:

  1. SeqTrainer BenchLab for dataset inspection and benchmark planning.
  2. SeqTrainer for model workflows and plasmid annotation.
  3. SBOL Validator for checking and converting biological design files.
  4. SBOL Canvas for viewing and editing genetic designs.

The guiding message is simple: Seq Design Buddy explains the workflow and directs you to the correct tool. Your files and models run in the original tools, not on this website.

What this website does not do

  • It does not upload, process, or store biological files.
  • It does not run models or provide GPU resources.
  • It does not connect to Colab, an HPC cluster, BenchLab, SeqTrainer, SBOL Validator, or SBOL Canvas.
  • It does not display simulated metrics, validation results, annotation results, or project state.
  • It does not include authentication, a database, an API proxy, a backend runner, or object storage.

External links open the original repository or official application in a new tab. Copy buttons only copy documented commands; they never execute them.

Site routes

  • / - overview, exactly four tool cards, workflow summary, and file handoffs.
  • /tools/benchlab - BenchLab setup, small local baselines, plan-only exports, JSON replay order, and outputs.
  • /tools/seqtrainer - SeqTrainer annotation prerequisites, dummy smoke command, DNABERT2 command, branch-specific SBOL export, and outputs.
  • /tools/sbol-validator - external Validator validation-only and validation-plus-conversion handoff instructions.
  • /tools/sbol-canvas - external Canvas import instructions for SBOL2 RDF/XML .rdf compatibility files.
  • /workflow - four beginner paths plus a static file handoff table.
  • /glossary - plain-language reference terms.

Development

This repository uses TanStack Start, React, TypeScript, Vite, and Tailwind CSS. No backend or Python runtime is required for the hub itself.

Install dependencies:

bun install

Run the local site:

npm run dev

Then open the local URL printed by Vite, usually http://127.0.0.1:5173/.

Run the checks:

npm run lint
npm run build
npm test

Content sources

Instruction content is based on the current source repositories and their documented branches:

When an upstream repository changes, review its current README and relevant documentation before updating the corresponding route. Do not copy personal filesystem paths, invent notebook locations, or imply that a branch contains capabilities it does not contain.

Design and accessibility

The hub uses a light scientific interface with high-contrast text, semantic headings, visible focus states, keyboard-accessible links and controls, descriptive external-link labels, readable command blocks, and responsive layouts. The workflow is represented with text and numbered steps, not colour alone.

Deployment

The existing Vite/TanStack Start deployment stack is preserved. Build with npm run build; the generated output remains compatible with the repository's Vercel deployment flow. The hub has no runtime service dependencies and should not require credentials, storage, server functions, or API routes.

Limitations

The site is intentionally educational and static. Tool behavior, supported formats, command-line interfaces, branch contents, external website availability, and scientific results belong to the original projects and should be verified there before use.

About

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages