Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
Command compatibility: New vibe-viewer and vibe-sketcher launchers require rename-aware builds. For current published archives or available public snapshots, use vibe-view and vibe-sketch; these deprecated commands remain supported with no removal date. vq is unchanged. Compatibility guide.
vibe-viewer documentation
Light Logo Dark Logo
vibe-viewer documentation

Getting started

  • Installation
  • Quickstart
  • From input to a shareable result
  • Correlated reaction endpoint analysis
  • ORCA: from calculation to one viewer dataset
  • Worked example: water through ORCA and vq
  • Worked example: Raman and VCD through ORCA and vq
  • A tour of the viewer
  • Build, inspect and present
  • What vibe-viewer can show you

Calculations and clusters

  • Supported programs and calculations
  • Preparing native calculation inputs
  • Clusters and remote machines
  • vibe-viewer with vibe-sketcher and vibe-qc

The surfaces

  • The browser viewer
  • Building and editing structures
  • Terminal mode
  • The desktop app
  • Figures without a display

Building, inspecting and presenting

  • Molecular construction
  • Nanotubes and tube–metal interfaces
  • Internal-coordinate API
  • Molecular surfaces and geometric interactions
  • Atom selection language
  • Experimental map coordinates
  • Publication figures and morph movies
  • Multi-model scene API

Data and formats

  • Input formats and interoperability
  • Database structures, ensembles and sequences
  • Cartoon display and producer metadata
  • The QVF format, from the consumer’s side

Reference

  • CLI reference
  • Python SDK
    • vibeview.api
    • vibeview.qvf
    • vibeview.kinds
    • vibeview.importers
    • vibeview.renderer_plugins
    • vibeview.codenames
  • Jobs and live results
  • Queue integration — the [queue] extra
  • Troubleshooting
  • Client performance

The project

  • Roadmap
  • vibe-sketcher and vibe-viewer: responsibilities
  • Release codenames
  • Release process
  • Distribution builds
  • Tests, builds and fast feedback
  • Changelog
  • Contributing
  • Project history and internals
    • vibe-viewer code audit — 2026-07-02
    • vibe-viewer design refresh 2026 — “THE QC visualization program”
    • Desktop packaging contract
    • Direct volume rendering design
    • Cross-repo asks for Avogadro-parity (vibe-viewer side)
    • vibe-viewer → Avogadro 2.0 parity roadmap
Back to top
Copyright © 2026, Michael F. Peintinger
Made with Sphinx and @pradyunsg's Furo