# drsiyarb/vagus_nerve_explorer architecture

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

## Overview

This repository publishes a human vagus-nerve atlas through two browser experiences, alongside manuscript data and reproducible analyses. The principal workflow is to explore the registered cohort in the static atlas: its generated data file supplies the browser interface, which supports filtering and four linked views. Separately, the manuscript notebook regenerates figures and tables from the analysis-ready workbook. A second browser visualization, Reflex Time, animates physiological reflex periods. The explorer builder’s input/output are explicit in its excerpt; most UI wiring and notebook internals were not sampled, so those relationships rely on README statements.

Main entry points: [`explorer/index.html`](https://github.com/drsiyarb/vagus_nerve_explorer/blob/main/explorer/index.html) (Atlas interface), [`paper/paper_figures_reproducible.ipynb`](https://github.com/drsiyarb/vagus_nerve_explorer/blob/main/paper/paper_figures_reproducible.ipynb) (Analysis notebook), [`paper/vagus_atlas_analysis.xlsx`](https://github.com/drsiyarb/vagus_nerve_explorer/blob/main/paper/vagus_atlas_analysis.xlsx) (Analysis workbook), [`explorer/vagus_atlas_data.js`](https://github.com/drsiyarb/vagus_nerve_explorer/blob/main/explorer/vagus_atlas_data.js) (Atlas data)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_atlas["Atlas Explorer"]
  node_explorer_ui["Atlas interface<br/>[index.html]"]
  node_atlas_data["Atlas data"]
  node_data_builder["Data builder"]
  node_filters["Cohort filters<br/>[index.html]"]
  node_branches["Branch view<br/>[index.html]"]
  node_subway["Subway map<br/>[index.html]"]
  node_distributions["Group distributions<br/>[index.html]"]
  node_selectivity["Selectivity view<br/>[index.html]"]
end

subgraph group_research["Research Data"]
  node_analysis_workbook[("Analysis workbook")]
  node_published_data[("Published dataset")]
  node_segment_scaffold["Registration scaffold"]
  node_notebook["Analysis notebook"]
  node_paper_outputs["Figures and tables"]
end

subgraph group_reflex["Reflex Time"]
  node_time_viewer["Reflex animation<br/>[app.js]"]
  node_time_page["Reflex Time page<br/>[index.html]"]
end

node_visitor(("Atlas visitor"))
node_time_user(("Time viewer user"))

node_visitor -->|"uses"| node_explorer_ui
node_analysis_workbook -->|"reads"| node_data_builder
node_data_builder -->|"generates"| node_atlas_data
node_atlas_data -->|"supplies data"| node_explorer_ui
node_explorer_ui -->|"exposes"| node_filters
node_explorer_ui -->|"renders"| node_branches
node_explorer_ui -->|"renders"| node_subway
node_explorer_ui -->|"renders"| node_distributions
node_explorer_ui -->|"renders"| node_selectivity
node_analysis_workbook -->|"analyzes"| node_notebook
node_published_data -.->|"reproduces from"| node_notebook
node_segment_scaffold -.->|"supports registration"| node_notebook
node_notebook -->|"regenerates"| node_paper_outputs
node_time_user -.->|"opens"| node_time_page
node_time_page -.->|"loads"| node_time_viewer

click node_explorer_ui "https://github.com/drsiyarb/vagus_nerve_explorer/blob/main/explorer/index.html"
click node_atlas_data "https://github.com/drsiyarb/vagus_nerve_explorer/blob/main/explorer/vagus_atlas_data.js"
click node_data_builder "https://github.com/drsiyarb/vagus_nerve_explorer/blob/main/explorer/build_atlas_data.py"
click node_filters "https://github.com/drsiyarb/vagus_nerve_explorer/blob/main/explorer/index.html"
click node_branches "https://github.com/drsiyarb/vagus_nerve_explorer/blob/main/explorer/index.html"
click node_subway "https://github.com/drsiyarb/vagus_nerve_explorer/blob/main/explorer/index.html"
click node_distributions "https://github.com/drsiyarb/vagus_nerve_explorer/blob/main/explorer/index.html"
click node_selectivity "https://github.com/drsiyarb/vagus_nerve_explorer/blob/main/explorer/index.html"
click node_analysis_workbook "https://github.com/drsiyarb/vagus_nerve_explorer/blob/main/paper/vagus_atlas_analysis.xlsx"
click node_published_data "https://github.com/drsiyarb/vagus_nerve_explorer/blob/main/paper/vagus_atlas_dataset.xlsx"
click node_segment_scaffold "https://github.com/drsiyarb/vagus_nerve_explorer/blob/main/paper/vagus_segment_scaffold_from_dd.xlsx"
click node_notebook "https://github.com/drsiyarb/vagus_nerve_explorer/blob/main/paper/paper_figures_reproducible.ipynb"
click node_paper_outputs "https://github.com/drsiyarb/vagus_nerve_explorer/tree/main/paper"
click node_time_viewer "https://github.com/drsiyarb/vagus_nerve_explorer/blob/main/reflex-time/app.js"
click node_time_page "https://github.com/drsiyarb/vagus_nerve_explorer/blob/main/reflex-time/index.html"

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_explorer_ui,node_atlas_data,node_data_builder,node_filters,node_branches,node_subway,node_distributions,node_selectivity,node_time_user toneBlue
class node_analysis_workbook,node_published_data,node_segment_scaffold,node_notebook,node_paper_outputs toneAmber
class node_time_viewer,node_time_page toneMint
class node_visitor toneIndigo
```

## Components

### Atlas Explorer

- [Atlas interface](https://github.com/drsiyarb/vagus_nerve_explorer/blob/main/explorer/index.html): `explorer/index.html`
- [Atlas data](https://github.com/drsiyarb/vagus_nerve_explorer/blob/main/explorer/vagus_atlas_data.js): `explorer/vagus_atlas_data.js`
- [Data builder](https://github.com/drsiyarb/vagus_nerve_explorer/blob/main/explorer/build_atlas_data.py): `explorer/build_atlas_data.py`
- [Cohort filters](https://github.com/drsiyarb/vagus_nerve_explorer/blob/main/explorer/index.html): `explorer/index.html`
- [Branch view](https://github.com/drsiyarb/vagus_nerve_explorer/blob/main/explorer/index.html): `explorer/index.html`
- [Subway map](https://github.com/drsiyarb/vagus_nerve_explorer/blob/main/explorer/index.html): `explorer/index.html`
- [Group distributions](https://github.com/drsiyarb/vagus_nerve_explorer/blob/main/explorer/index.html): `explorer/index.html`
- [Selectivity view](https://github.com/drsiyarb/vagus_nerve_explorer/blob/main/explorer/index.html): `explorer/index.html`

### Research Data

- [Analysis workbook](https://github.com/drsiyarb/vagus_nerve_explorer/blob/main/paper/vagus_atlas_analysis.xlsx): `paper/vagus_atlas_analysis.xlsx`
- [Published dataset](https://github.com/drsiyarb/vagus_nerve_explorer/blob/main/paper/vagus_atlas_dataset.xlsx): `paper/vagus_atlas_dataset.xlsx`
- [Registration scaffold](https://github.com/drsiyarb/vagus_nerve_explorer/blob/main/paper/vagus_segment_scaffold_from_dd.xlsx): `paper/vagus_segment_scaffold_from_dd.xlsx`
- [Analysis notebook](https://github.com/drsiyarb/vagus_nerve_explorer/blob/main/paper/paper_figures_reproducible.ipynb): `paper/paper_figures_reproducible.ipynb`
- [Figures and tables](https://github.com/drsiyarb/vagus_nerve_explorer/tree/main/paper): `paper`

### Reflex Time

- [Reflex animation](https://github.com/drsiyarb/vagus_nerve_explorer/blob/main/reflex-time/app.js): `reflex-time/app.js`
- [Reflex Time page](https://github.com/drsiyarb/vagus_nerve_explorer/blob/main/reflex-time/index.html): `reflex-time/index.html`

### Other components

- **Atlas visitor**
- **Time viewer user**

## Connections

- Atlas visitor → Atlas interface: uses (evidence: `README.md`)
- Analysis workbook → Data builder: reads (evidence: `explorer/build_atlas_data.py`)
- Data builder → Atlas data: generates (evidence: `explorer/build_atlas_data.py`)
- Atlas data → Atlas interface: supplies data
- Atlas interface → Cohort filters: exposes (evidence: `README.md`)
- Atlas interface → Branch view: renders (evidence: `README.md`)
- Atlas interface → Subway map: renders (evidence: `README.md`)
- Atlas interface → Group distributions: renders (evidence: `README.md`)
- Atlas interface → Selectivity view: renders (evidence: `README.md`)
- Analysis workbook → Analysis notebook: analyzes (evidence: `README.md`)
- Published dataset → Analysis notebook: reproduces from
- Registration scaffold → Analysis notebook: supports registration
- Analysis notebook → Figures and tables: regenerates (evidence: `README.md`)
- Time viewer user → Reflex Time page: opens
- Reflex Time page → Reflex animation: loads
