# gabeah/thesis architecture

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

- Interactive diagram: https://gitdiagram.com/gabeah/thesis
- Repository: https://github.com/gabeah/thesis

## Overview

This repository is organized as a comprehensive thesis work archive that includes research notes, code experiments, documents in LaTeX, multimedia evidences, and checkpoint files. In other words, it’s an archival project for Gabe's Thesis which brings together different components such as note-taking (managed via Obsidian), code experiments (stored in the python-files directory), formal thesis documents (in the thesis_doc folder), and supporting media like videos.

##### Main Components
- Notes & Research Material: Represented by the “ObsidianNotes” folder. This includes many Markdown files, Obsidian configuration files, and even plugins (e.g., obsidian-latex-suite, obsidian-tasks-plugin) that suggest extended note-taking and even some LaTeX support within Obsidian.
- Thesis Document & Bibliography: Contained in “thesis_doc” and accompanying files like Thesis Handbook PDFs and LaTeX source files. This part forms the core of the formal thesis documentation work.
- Code Experiments & Simulations: The “python-files” directory holds several Python scripts related to graphics, OpenCV, multimedia processing, and tracking tasks. These form the research experiments or computational side of the thesis.
- Multimedia and Supplementary Materials: The “Videos” directory and checkpoint folders contain videos and possibly earlier checkpoint versions – evidence, recordings, or iterative drafts that support the research.
- Miscellaneous/Project Configuration: Files like .gitignore, project workspace files, and even exported citations (Primo_RIS_Export.ris) provide context on the tools and version control being used.

##### Out Their Relationships and Interactions
- The Notes component (ObsidianNotes) feeds into the written thesis (thesis_doc) by providing research outlines, progress logs, and idea documentation.
- Code Experiments (python-files) produce outputs, simulations, or visual evidence that may be integrated or referenced in the thesis.
- Multimedia content (Videos) supports and provides visual demonstrations of experiments or presentations of thesis concepts.
- Checkpoints are used to record iterative progress and may interlink both with the experimental code and the evolving thesis documentation.

##### Architectural Patterns or Design Principles
- Modular Separation: Although it isn’t a traditional multi-tier application, the project exhibits clear modularity — different directories encapsulate distinct aspects (notes, source documents, code experiments, and multimedia).
- Iterative Development and Versioning: Checkpoint versions and the use of version control (evidenced by .gitignore and structure snapshots) show an iterative working process.
- Integration of External Tools: Obsidian (note-taking and markdown management), LaTeX for thesis typesetting, and Python libraries (for graphics and OpenCV tasks) are central to the methodology.

##### Relevant Technologies, Frameworks, or Libraries
- Obsidian: For managing and organizing research notes.
- LaTeX: Document preparation system used for the thesis (with several styles, bibliographies, and class files provided).
- Python & OpenCV: For experiments, processing, and potentially generating visual content or analytics related to the research.
- Possibly version control (Git) and development environments (VSCode, workspace configurations) that empower the research and writing process.

- Clear Labels: Each major folder (or component) should be clearly labeled (e.g., “ObsidianNotes – Research & Notes”, “Thesis_Doc – Formal Documentation”, “Python-Files – Code & Experiments”, “Videos – Multimedia Evidence”).
- Annotations: Optionally, add notes regarding the role of external tools (e.g., “Obsidian Plugin Configurations” in ObsidianNotes, “LaTeX Styles/Bibliographies” in thesis_doc).

##### Detail
- Aim to capture every logical section of the project—even though the repository is not a live application, breaking it down into as many distinct components (as listed above) will help illustrate the full architecture of Gabe’s thesis work.
- Do not hesitate to create sub-components within each major module if any further internal structure is needed (e.g., within thesis_doc, separate the bibliographies, figures, and the LaTeX build system).

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Research & Notes Layer
    subgraph "Research & Notes"
        ON["ObsidianNotes – Research & Notes"]:::notes
    end

    %% Document Authoring Layer
    subgraph "Document Authoring"
        TD["thesis_doc – Formal Documentation"]:::thesis
    end

    %% Experimentation & Code Layer
    subgraph "Experimentation & Code"
        PF["python-files – Code & Experiments"]:::code
    end

    %% Supporting Media Layer
    subgraph "Supporting Media"
        VM["Videos – Multimedia Evidence"]:::media
        CP["checkpoint_11_27_24 – Checkpoint Files"]:::media
    end

    %% Configuration & Metadata Layer
    subgraph "Configuration & Metadata"
        GI[".gitignore – VCS & Config"]:::config
        WS["thesis.code-workspace – Project Workspace"]:::config
        PR["Primo_RIS_Export.ris – Exported Citations"]:::config
    end

    %% Connections / Data Flow
    ON -->|"feeds" | TD
    PF -->|"supports" | TD
    PF -->|"generates" | VM
    PF -->|"logs_progress" | CP

    %% Styles
    classDef notes fill:#AED6F1,stroke:#1F618D,stroke-width:2px;
    classDef thesis fill:#A9DFBF,stroke:#27AE60,stroke-width:2px;
    classDef code fill:#F9E79F,stroke:#D4AC0D,stroke-width:2px;
    classDef media fill:#F5CBA7,stroke:#E67E22,stroke-width:2px;
    classDef config fill:#D7BDE2,stroke:#8E44AD,stroke-width:2px;

    %% Click Events
    click ON "https://github.com/gabeah/thesis/tree/main/ObsidianNotes/"
    click TD "https://github.com/gabeah/thesis/tree/main/thesis_doc/"
    click PF "https://github.com/gabeah/thesis/tree/main/python-files/"
    click VM "https://github.com/gabeah/thesis/tree/main/Videos/"
    click CP "https://github.com/gabeah/thesis/tree/main/checkpoint_11_27_24/"
    click GI "https://github.com/gabeah/thesis/blob/main/.gitignore"
    click WS "https://github.com/gabeah/thesis/blob/main/thesis.code-workspace"
    click PR "https://github.com/gabeah/thesis/blob/main/Primo_RIS_Export.ris"
```
