# jrjhealey/isis architecture

> Architecture diagram of the GitHub repository jrjhealey/isis, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-01-31). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/jrjhealey/isis
- Repository: https://github.com/jrjhealey/isis

## Overview

Key Components to Include in the System Design:

##### Core Processing Components
- Input Processing Layer
- FASTA sequence handling
- PDB structure processing
- Prediction Engine Layer
- Multiple prediction methods (Chou-Fasman, Emini, Karplus-Schulz, Kolaskar-Tongaonkar)
- Visualization Layer
- UCSF Chimera integration
- Epitope rendering

##### Main System Flow
a. Sequence Generation Flow
b. Prediction Flow
c. Visualization Flow

##### Top Level (Input Layer)
- PDB Structure input
- FASTA Sequence input

##### Middle Layer (Processing)
- Sequence Processing (BCellRunner.py)
- Epitope Prediction Engine (antibody_epitope_prediction.py)
- Method Calculations (method_calculation.py)

##### Bottom Layer (Output/Visualization)
- UCSF Chimera Integration
- Epitope Rendering System
- Results Output (.epi files)

Important Considerations:

##### Connection Types
- Double lines for API interactions

##### Special Elements
- A "Python 2.7" requirement badge
- UCSF Chimera as an external dependency
- BioPython integration points

##### Component Details

- Module Name    |

- Key Functions  |
- Dependencies   |

##### Specific Implementation Notes
- Four prediction methods as parallel processors
- Sequence window processing
- Scoring system integration

##### External Dependencies
- UCSF Chimera
- BioPython
- Python 2.7

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Style Definitions
    classDef input fill:#a8d1f0,stroke:#000
    classDef processing fill:#90EE90,stroke:#000
    classDef prediction fill:#FFA500,stroke:#000
    classDef visualization fill:#DDA0DD,stroke:#000
    classDef external fill:#D3D3D3,stroke:#000

    %% Input Layer
    subgraph Input
        PDB[("PDB Structure")]:::input
        FASTA[("FASTA Sequence")]:::input
    end

    %% Processing Layer
    subgraph Processing
        BCRunner["Input Processing"]:::processing
        PredEngine["Prediction Engine"]:::processing
        MethodCalc["Method Calculations"]:::processing
    end

    %% Prediction Methods
    subgraph "Prediction Methods"
        CF["Chou-Fasman"]:::prediction
        EM["Emini"]:::prediction
        KS["Karplus-Schulz"]:::prediction
        KT["Kolaskar-Tongaonkar"]:::prediction
    end

    %% Visualization Layer
    subgraph Visualization
        ChimeraInt["UCSF Chimera Integration"]:::visualization
        EpiRender["Epitope Renderer"]:::visualization
        Results[".epi Results"]:::visualization
    end

    %% External Dependencies
    subgraph Dependencies
        Python["Python 2.7"]:::external
        Chimera["UCSF Chimera"]:::external
        BioPython["BioPython"]:::external
    end

    %% Connections
    PDB --> BCRunner
    FASTA --> BCRunner
    BCRunner --> PredEngine
    PredEngine --> MethodCalc
    MethodCalc --> CF & EM & KS & KT
    CF & EM & KS & KT --> EpiRender
    EpiRender --> ChimeraInt
    ChimeraInt --> Results

    %% Component Mappings
    click BCRunner "https://github.com/jrjhealey/ISIS/blob/master/bcell_standalone/BCellRunner.py"
    click PredEngine "https://github.com/jrjhealey/ISIS/blob/master/bcell_standalone/antibody_epitope_prediction.py"
    click MethodCalc "https://github.com/jrjhealey/ISIS/blob/master/bcell_standalone/method_calculation.py"
    click ChimeraInt "https://github.com/jrjhealey/ISIS/blob/master/ISIS2Chimera.py"
    click EpiRender "https://github.com/jrjhealey/ISIS/blob/master/EpitopeRenderer.py"

    %% Legend
    subgraph Legend
        L1["Input Components"]:::input
        L2["Processing Modules"]:::processing
        L3["Prediction Algorithms"]:::prediction
        L4["Visualization Components"]:::visualization
        L5["External Dependencies"]:::external
    end
```
