Skip to content

README.md

Latest commit

 

History

History
88 lines (65 loc) · 1.75 KB

README.md

File metadata and controls

88 lines (65 loc) · 1.75 KB
Raw

Protein Sequence Viewer

A simple Qt6-based GUI application for visualizing protein sequences from .pdb files.

Table of Contents

  1. Installation
  2. Usage
  3. Configuration
  4. Project Structure

Installation

Prerequisites

  • C++17 or later
  • CMake 3.16+
  • Qt6 (Core, Gui, Widgets) installed and available in your system path
    • e.g. on Ubuntu apt install qt6-base-dev

Steps

Clone the repository:

git clone https://github.com/katkanaz/sequence-viewer.git

cd sequence-viewer

Create the build directory:

mkdir build && cd build

Configure and build with CMake

cmake ..
cmake --build .

Usage

Run the application from the build directory:

./sequence-viewer
  • Click Open File to load .pdb file
  • The protein residues are drawn as rectangles where each color represents a specific amino acid
  • Click on residue to highlight and display details (residue name and number, number of atoms)
  • Click Hide to hide the letters representing the amino acids
  • Click Show to make them appear again
Example of 2dhc.pdb in dark mode Example of 2dhc.pdb in light mode

Configuration

Uses CMake with AUTOMAC enabled, no need for manual qmake.

Project Structure

protein-sequence-viewer/
│
├── build/
├── data/ # Example .pdb file for testing
├── include/
├── src/
├── CMakeLists.txt
└── README.md