# jrjhealey/oread architecture

> Architecture diagram of the GitHub repository jrjhealey/oread, 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/oread
- Repository: https://github.com/jrjhealey/oread

## Overview

##### Main Components

a) User Interface Layer:
- GUI Component (powered by Gooey)
- CLI Component (--ignore-gooey mode)

b) Core Processing Layer:
- File Processing Module
- BLAST+ Integration
- Sequence Processing (BioPython)

c) External Dependencies:
- BLAST+ Suite
- BioPython
- Gooey Framework

**[User] → [Interface Layer] → [Core Processing] → [Output Files]**

##### Important Elements to Highlight

- Blue: User interfaces
- Green: Core processing
- Yellow: External dependencies
- Gray: System requirements

- Direction: Data/control flow

##### Specific Implementation Details

a) Entry Points:
- Oread.py as the main entry point
- Bifurcation between GUI and CLI modes

b) Processing Flow:
- Input file handling
- BLAST+ processing
- Artemis file generation

##### Additional Details

- Configuration flow
- Error handling
- File format conversions
- Integration points with Artemis tools

Remember to include version information (from version.py) and licensing information, as these are part of the project structure.

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph Legend
        UI[User Interface]:::ui
        CORE[Core Processing]:::core
        DEP[External Dependency]:::dependency
        SYS[System Requirement]:::system
    end

    subgraph "Interface Layer"
        GUI[GUI Interface]:::ui
        CLI[CLI Interface]:::ui
        EP[Entry Point]:::core
    end

    subgraph "Core Processing"
        FP[File Processing]:::core
        BP[BioPython Integration]:::core
        BLAST[BLAST+ Processing]:::core
        VM[Version Management]:::core
    end

    subgraph "External Dependencies"
        BLASTP[BLAST+ Suite]:::dependency
        BIOP[BioPython]:::dependency
        GOOEY[Gooey Framework]:::dependency
    end

    subgraph "System Requirements"
        PYTHON[Framework Python]:::system
        CONDA[Conda/Pip]:::system
    end

    %% Connections
    USER((User)) --> EP
    EP --> GUI
    EP --> CLI
    GUI --> FP
    CLI --> FP
    FP --> BP
    FP --> BLAST
    BP --> OUTPUT[Artemis Files]:::core
    BLAST --> OUTPUT

    %% Dependencies
    GOOEY -.-> GUI
    BIOP -.-> BP
    BLASTP -.-> BLAST
    PYTHON -.-> EP
    CONDA -.-> PYTHON

    %% Click Events
    click EP "https://github.com/jrjhealey/Oread/blob/master/Oread.py"
    click EP "https://github.com/jrjhealey/Oread/blob/master/oread/__main__.py"
    click VM "https://github.com/jrjhealey/Oread/blob/master/oread/version.py"
    click EP "https://github.com/jrjhealey/Oread/blob/master/oread/__init__.py"
    click EP "https://github.com/jrjhealey/Oread/blob/master/Oread.spec"
    click EP "https://github.com/jrjhealey/Oread/blob/master/setup.py"

    %% Styles
    classDef ui fill:#a8d1f0,stroke:#333
    classDef core fill:#90EE90,stroke:#333
    classDef dependency fill:#FFE5B4,stroke:#333,stroke-dasharray: 5 5
    classDef system fill:#D3D3D3,stroke:#333
    classDef default fill:#fff,stroke:#333
```
