# semccomas/glut5_string architecture

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

- Interactive diagram: https://gitdiagram.com/semccomas/glut5_string
- Repository: https://github.com/semccomas/glut5_string

## Overview

##### Project type and purpose
- This is a scientific-computing “pipeline” project for molecular dynamics (MD) simulations and analysis of the GLUT5 transporter. It’s not a traditional web app or microservice suite, but rather a multi-stage workflow combining homology modeling, conventional MD, targeted MD (TMD), “string” path sampling, and extensive post-processing/analysis, all orchestrated via scripts, Jupyter notebooks, and HPC batch jobs.

##### Directory/Component breakdown
- Top-level modules:
- homology_modeling: scripts to generate starting structural models (IN, OUT, OCC states)
- GLUT5_atomistic: conventional MD simulations + analysis notebooks for end-state validation
- steered (state_by_state_running + analysis): targeted MD (TMD) via PLUMED, plus analysis of TMD data and selection of frames for strings
- string (string_sims + analysis): initialization and execution of string-method swarms, FES/histogram extraction, MSM weight calculations, and all downstream analyses for figures
- Supporting files:
- plumed*.dat, run_TMD.sh, SLURM scripts under steered/…/plumed_master
- Conda environment yml files under string/analysis/scripts/conda_env
- GMX command wrappers under string/analysis/scripts/gmx_commands
- Jupyter notebooks and Python scripts for plotting, clustering, feature extraction

##### Key external technologies & environments
- GROMACS (MD engine)
- PLUMED (plugin for TMD)
- SLURM (HPC scheduler, “Beskow” cluster)
- Conda (envs for string-method workflows)
- Python (analysis, notebooks), Jupyter, NumPy/Pandas/MDAnalysis
- Delemotte lab’s string-method-swarms-trajectories codebase as downstream library

- Raw structures → homology → MD runs → steered runs → string swarms → analysis

##### Final remarks
- Modularity is clear—each top-level directory is a self-contained pipeline stage
- External integrations (GROMACS, PLUMED, SLURM, Conda) to show the full ecosystem

This level of detail will allow stakeholders to see both the big-picture pipeline and the critical components, interactions, and dependencies that power the GLUT5 string simulations project.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Compute stages
    subgraph "Compute Stages"
        direction TB
        Homo["Homology Modeling"]:::compute
        Atom["Atomistic MD Module"]:::compute
        TMD["Targeted MD (TMD) Module"]:::compute
        StringSim["String-Method Swarm Module"]:::compute
    end

    %% Analysis stages
    subgraph "Analysis Stages"
        direction TB
        AtomAnalysis["Atomistic MD Analysis"]:::analysis
        TMDAnalysis["TMD Analysis"]:::analysis
        StringAnalysis["String-Method Analysis & Post-Processing"]:::analysis
        FinalAnalysis["Final Figure Generation"]:::analysis
    end

    %% Infrastructure and artifacts
    SLURM["HPC Scheduler (SLURM)"]:::infra
    DataStore["Data Store\n(trajectories, confouts,\nhistograms, MSM weights)"]:::datastore
    Envs["Conda Envs & External Libraries"]:::env

    %% Flow
    Homo -->|"initial structures"| Atom
    Atom -->|"end-state trajectories"| AtomAnalysis
    Atom -->|"end-state trajectories"| TMD
    TMD -->|"steered trajectories & confouts"| DataStore
    TMD -->|"selected frames"| StringSim
    StringSim -->|"swarm outputs & histograms"| DataStore
    DataStore -->|"loads trajectories & histograms"| FinalAnalysis
    AtomAnalysis --> FinalAnalysis
    TMDAnalysis --> FinalAnalysis
    StringAnalysis --> FinalAnalysis

    %% Scheduler connections
    Homo --> SLURM
    Atom --> SLURM
    TMD --> SLURM
    StringSim --> SLURM

    %% Environments reference
    Homo --> Envs
    Atom --> Envs
    TMD --> Envs
    StringSim --> Envs
    AtomAnalysis --> Envs
    TMDAnalysis --> Envs
    StringAnalysis --> Envs

    %% Click Events
    click Homo "https://github.com/semccomas/glut5_string/tree/master/homology_modeling/make_model_scripts"
    click Atom "https://github.com/semccomas/glut5_string/tree/master/GLUT5_atomistic"
    click AtomAnalysis "https://github.com/semccomas/glut5_string/tree/master/GLUT5_atomistic/analysis/scripts"
    click TMD "https://github.com/semccomas/glut5_string/tree/master/steered/state_by_state_running/targeted_MD/plumed_master"
    click TMDAnalysis "https://github.com/semccomas/glut5_string/tree/master/steered/analysis/scripts"
    click StringSim "https://github.com/semccomas/glut5_string/tree/master/string/string_sims"
    click StringAnalysis "https://github.com/semccomas/glut5_string/tree/master/string/analysis/scripts"
    click Envs "https://github.com/semccomas/glut5_string/blob/master/string/analysis/scripts/conda_env/environment.yml"
    click Envs "https://github.com/semccomas/glut5_string/blob/master/string/analysis/scripts/conda_env/environment_string_method.yml"
    click Envs "https://github.com/semccomas/glut5_string/blob/master/string/analysis/scripts/conda_env/environment_update_string_method.yml"
    click TMD "https://github.com/semccomas/glut5_string/blob/master/steered/state_by_state_running/targeted_MD/plumed_master/run_TMD.sh"
    click StringSim "https://github.com/semccomas/glut5_string/blob/master/string/string_sims/TMD_initial_path/*/slurm_string_beskow.sh"
    click StringAnalysis "https://github.com/semccomas/glut5_string/tree/master/string/analysis/scripts/gmx_commands"
    click AtomAnalysis "https://github.com/semccomas/glut5_string/tree/master/GLUT5_atomistic/analysis/scripts"
    click TMDAnalysis "https://github.com/semccomas/glut5_string/tree/master/steered/analysis/scripts"
    click StringAnalysis "https://github.com/semccomas/glut5_string/tree/master/string/analysis/scripts"
    click StringSim "https://github.com/semccomas/glut5_string/tree/master/string/string_sims/TMD_initial_path/*"

    %% Styles
    classDef compute fill:#AED6F1,stroke:#3498DB,color:#1B4F72
    classDef analysis fill:#A9DFBF,stroke:#27AE60,color:#145A32
    classDef infra fill:#F9E79F,stroke:#F1C40F,color:#7D6608
    classDef env fill:#FAD7A0,stroke:#EB984E,color:#7E5109
    classDef datastore fill:#D5D8DC,stroke:#A6ACAF,color:#424949
```
