Getting Started
Welcome to BGC Viewer! This guide will help you get started with visualizing biosynthetic gene clusters.
What is BGC Viewer?
BGC Viewer is an interactive visualization tool for exploring Biosynthetic Gene Clusters (BGCs) from antiSMASH output files and other formats that contain feature and annotation data, such as GenBank files. It provides:
- Interactive track viewer - Zoom, pan, and explore gene clusters
- Domain annotations - Visualize protein domains and their functions
- Web components - Easy integration into your own applications
Architecture
BGC Viewer consists of two main components:
Backend (Python + Flask)
The (optional) backend provides:
- Data preprocessing and indexing
- REST API for data access
- Database management
- File handling utilities
Frontend (Vue.js + TypeScript)
The frontend provides:
- Interactive visualization components
- Web components for easy embedding
- Responsive UI
Next Steps
- Installation Guide - Set up BGC Viewer
- Quick Start - Run your first visualization
- Component Reference - Explore available components