Skip to content

Commit ce900a6

Browse files
Copilotdfeen87
andauthored
Add repository structure tree to README
Agent-Logs-Url: https://github.com/dfeen87/Smartphone-Based-Chest-Monitoring/sessions/da6ef261-000e-4bc1-a6d3-10fb08a4f8e2 Co-authored-by: dfeen87 <158860247+dfeen87@users.noreply.github.com>
1 parent 77b2ed9 commit ce900a6

1 file changed

Lines changed: 71 additions & 0 deletions

File tree

README.md

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,7 @@ bash reproduce_all.sh --physionet
5959

6060
## 📋 Table of Contents
6161

62+
- [Repository Structure](#️-repository-structure)
6263
- [Overview](#overview)
6364
- [Pipeline Overview](#pipeline-overview)
6465
- [Phase–Memory Operator](#phasememory-operator)
@@ -82,6 +83,76 @@ bash reproduce_all.sh --physionet
8283

8384
---
8485

86+
## 🗂️ Repository Structure
87+
88+
```
89+
Smartphone-Based-Chest-Monitoring/
90+
├── core/ # Cross-platform C++ engine
91+
│ ├── respirosync_core.cpp # Phase–memory operator implementation
92+
│ └── respirosync_core.h # Public C/C++ API header
93+
94+
├── android/ # Android integration
95+
│ ├── app/src/main/java/com/respirosync/demo/
96+
│ │ └── MainActivity.kt # Android demo application
97+
│ ├── engine/
98+
│ │ └── RespiroSyncEngine.kt # Kotlin engine wrapper
99+
│ └── jni/
100+
│ └── respirosync_android.cpp # JNI bridge to core
101+
102+
├── ios/ # iOS integration
103+
│ ├── RespiroSyncDemo/
104+
│ │ └── ContentView.swiftContentView.swift # SwiftUI demo app
105+
│ └── bridge/
106+
│ └── respirosync_ios.mm # Objective-C++ bridge to core
107+
108+
├── server/ # Python web server & dashboard
109+
│ ├── app.py # Flask/web server entry point
110+
│ ├── static/
111+
│ │ └── index.html # Live monitoring dashboard UI
112+
│ └── __init__.py
113+
114+
├── validation/ # Validation & reproducibility pipeline
115+
│ ├── pipeline.py # Core validation pipeline (deterministic)
116+
│ ├── validate_bidmc.py # Single-record BIDMC validation
117+
│ ├── multi_record_validation.py # Multi-record batch validation
118+
│ ├── physionet_loader.py # PhysioNet / BIDMC data loader
119+
│ ├── metrics.py # Statistical metrics (MAE, RMSE, etc.)
120+
│ ├── perturbations.py # Signal perturbation utilities
121+
│ ├── plots.py # Figure generation
122+
│ ├── requirements.txt # Validation-specific Python deps
123+
│ └── __init__.py
124+
125+
├── tests/ # Automated tests
126+
│ ├── test_core.cpp # C++ unit tests for the core engine
127+
│ └── test_server.py # Python tests for the web server
128+
129+
├── docs/ # Extended documentation
130+
│ ├── ARCHITECTURE.md # System architecture details
131+
│ ├── BUILDING.md # Build instructions
132+
│ ├── CHANGELOG.md # Version history
133+
│ ├── PLATFORMS.md # Platform support notes
134+
│ ├── PRODUCTION_IMPROVEMENTS.md # Roadmap for production use
135+
│ ├── QUICKSTART.md # Quick-start guide
136+
│ ├── SECURITY.md # Security considerations
137+
│ ├── SIGNALS.md # Signal processing reference
138+
│ └── VALIDATION.md # Validation protocol details
139+
140+
├── results/ # Output directory for validation results
141+
│ └── .gitkeep
142+
143+
├── PAPER.md # Full scientific paper (canonical reference)
144+
├── RESULT_ANALYSIS.md # Analysis of validation results
145+
├── reproduce_all.sh # One-command reproducibility script
146+
├── Makefile # Build targets (core, tests, clean)
147+
├── requirements.txt # Top-level Python dependencies
148+
├── render.yaml # Render.com deployment configuration
149+
├── CITATION.cff # Citation metadata
150+
├── LICENSE # MIT License
151+
└── README.md # This file
152+
```
153+
154+
---
155+
85156
## Overview
86157

87158
RespiroSync is a portable, on-device engine for estimating respiratory patterns

0 commit comments

Comments
 (0)