# costalab/scaccordion architecture

> Architecture diagram of the GitHub repository costalab/scaccordion, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-06). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/costalab/scaccordion
- Repository: https://github.com/costalab/scaccordion

## Overview

scACCorDiON is a Python toolkit for comparing and clustering directed, weighted cell–cell communication graphs with optimal transport. The main workflow takes per-sample interaction tables into Accordion, which builds graph representations, derives graph-based costs, and computes pairwise Wasserstein distances; those distances can then be evaluated against sample labels. The package also exposes k-barycenter clustering for interpretable cluster representatives, graph-distance implementations, and bundled PDAC/example-data loaders. The source excerpts show Accordion’s internal calls; README claims about broader analysis and barycenter capabilities are documented, but their complete orchestration is not shown.

Main entry points: [`scaccordion/tools/Accordion.py`](https://github.com/costalab/scaccordion/blob/main/scaccordion/tools/Accordion.py) (Accordion), [`scaccordion/tools/datasets.py`](https://github.com/costalab/scaccordion/blob/main/scaccordion/tools/datasets.py) (Dataset Loaders), [`scaccordion/tools/utils.py`](https://github.com/costalab/scaccordion/blob/main/scaccordion/tools/utils.py) (Graph Matrices), [`scaccordion/tools/distances.py`](https://github.com/costalab/scaccordion/blob/main/scaccordion/tools/distances.py) (Graph Costs)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_analysis["Graph Analysis"]
  node_accordion["Accordion<br/>[Accordion.py]"]
  node_graphmatrix["Graph Matrices<br/>[utils.py]"]
end

subgraph group_metrics["Distance Methods"]
  node_graphcost["Graph Costs<br/>[distances.py]"]
  node_gwot["Directed GWOT<br/>[GWOT.py]"]
  node_got["Graph OT<br/>[GOT.py]"]
end

subgraph group_clustering["Clustering"]
  node_barycenters["K Barycenters<br/>[KBarycenters.py]"]
  node_evaluation["Label Evaluation<br/>[utils.py]"]
end

subgraph group_data["Data and Access"]
  node_datasetloaders["Dataset Loaders<br/>[datasets.py]"]
  node_packagedata[("Bundled Data")]
end

node_user(("Analyst"))

node_user -->|"provides tables"| node_accordion
node_accordion -->|"builds matrices"| node_graphmatrix
node_accordion -->|"computes costs"| node_graphcost
node_accordion -->|"evaluates distances"| node_evaluation
node_user -.->|"provides inputs"| node_barycenters
node_user -.->|"compares graphs"| node_gwot
node_user -.->|"compares graphs"| node_got
node_user -->|"requests data"| node_datasetloaders
node_datasetloaders -->|"reads bundled data"| node_packagedata

click node_accordion "https://github.com/costalab/scaccordion/blob/main/scaccordion/tools/Accordion.py"
click node_graphmatrix "https://github.com/costalab/scaccordion/blob/main/scaccordion/tools/utils.py"
click node_graphcost "https://github.com/costalab/scaccordion/blob/main/scaccordion/tools/distances.py"
click node_gwot "https://github.com/costalab/scaccordion/blob/main/scaccordion/tools/GWOT.py"
click node_got "https://github.com/costalab/scaccordion/blob/main/scaccordion/tools/GOT.py"
click node_barycenters "https://github.com/costalab/scaccordion/blob/main/scaccordion/tools/KBarycenters.py"
click node_evaluation "https://github.com/costalab/scaccordion/blob/main/scaccordion/tools/utils.py"
click node_datasetloaders "https://github.com/costalab/scaccordion/blob/main/scaccordion/tools/datasets.py"
click node_packagedata "https://github.com/costalab/scaccordion/tree/main/scaccordion/data"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_accordion,node_graphmatrix toneBlue
class node_graphcost,node_gwot,node_got toneAmber
class node_barycenters,node_evaluation toneMint
class node_datasetloaders,node_packagedata toneRose
class node_user toneIndigo
```

## Components

### Graph Analysis

- [Accordion](https://github.com/costalab/scaccordion/blob/main/scaccordion/tools/Accordion.py): `scaccordion/tools/Accordion.py`
- [Graph Matrices](https://github.com/costalab/scaccordion/blob/main/scaccordion/tools/utils.py): `scaccordion/tools/utils.py`

### Distance Methods

- [Graph Costs](https://github.com/costalab/scaccordion/blob/main/scaccordion/tools/distances.py): `scaccordion/tools/distances.py`
- [Directed GWOT](https://github.com/costalab/scaccordion/blob/main/scaccordion/tools/GWOT.py): `scaccordion/tools/GWOT.py`
- [Graph OT](https://github.com/costalab/scaccordion/blob/main/scaccordion/tools/GOT.py): `scaccordion/tools/GOT.py`

### Clustering

- [K Barycenters](https://github.com/costalab/scaccordion/blob/main/scaccordion/tools/KBarycenters.py): `scaccordion/tools/KBarycenters.py`
- [Label Evaluation](https://github.com/costalab/scaccordion/blob/main/scaccordion/tools/utils.py): `scaccordion/tools/utils.py`

### Data and Access

- [Dataset Loaders](https://github.com/costalab/scaccordion/blob/main/scaccordion/tools/datasets.py): `scaccordion/tools/datasets.py`
- [Bundled Data](https://github.com/costalab/scaccordion/tree/main/scaccordion/data): `scaccordion/data`

### Other components

- **Analyst**

## Connections

- Analyst → Accordion: provides tables (evidence: `scaccordion/tools/Accordion.py`)
- Accordion → Graph Matrices: builds matrices (evidence: `scaccordion/tools/Accordion.py`)
- Accordion → Graph Costs: computes costs (evidence: `scaccordion/tools/Accordion.py`)
- Accordion → Label Evaluation: evaluates distances (evidence: `scaccordion/tools/Accordion.py`)
- Analyst → K Barycenters: provides inputs (evidence: `README.md`)
- Analyst → Directed GWOT: compares graphs
- Analyst → Graph OT: compares graphs
- Analyst → Dataset Loaders: requests data (evidence: `scaccordion/tools/datasets.py`)
- Dataset Loaders → Bundled Data: reads bundled data (evidence: `scaccordion/tools/datasets.py`)
