Skip to content

Commit 656ef1f

Browse files
committed
Restructure dashboard: move to utils/dashboard; rename DASHBOARD.md to README.md; update README usage paths
1 parent a73abb9 commit 656ef1f

3 files changed

Lines changed: 10 additions & 10 deletions

File tree

DASHBOARD.md renamed to utils/dashboard/README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -78,15 +78,15 @@ Interactive time-series analysis with advanced visualization controls:
7878

7979
### Installation
8080
```bash
81-
# Navigate to project directory
81+
# Navigate to project root
8282
cd rusty-comms
8383

8484
# Create and activate virtual environment
8585
python -m venv venv
8686
source venv/bin/activate # On Windows: venv\Scripts\activate
8787

88-
# Install dashboard dependencies
89-
pip install -r requirements.txt
88+
# Install dashboard dependencies (path within repo)
89+
pip install -r utils/dashboard/requirements.txt
9090
```
9191

9292
### Required Dependencies
@@ -102,17 +102,17 @@ dash-table==5.0.0
102102

103103
### Starting the Dashboard
104104
```bash
105-
# Basic usage (current directory)
106-
python dashboard.py --dir .
105+
# Basic usage (from project root)
106+
python utils/dashboard/dashboard.py --dir .
107107

108108
# Specify custom data directory
109-
python dashboard.py --dir /path/to/benchmark/data
109+
python utils/dashboard/dashboard.py --dir /path/to/benchmark/data
110110

111111
# Custom host and port
112-
python dashboard.py --dir . --host 0.0.0.0 --port 8080
112+
python utils/dashboard/dashboard.py --dir . --host 0.0.0.0 --port 8080
113113

114114
# Enable debug mode (warning: may cause auto-reloading)
115-
python dashboard.py --dir . --debug
115+
python utils/dashboard/dashboard.py --dir . --debug
116116
```
117117

118118
### Command Line Options
@@ -256,15 +256,15 @@ lsof -i :8050
256256
### Debug Mode
257257
```bash
258258
# Enable verbose logging
259-
python dashboard.py --dir . --debug
259+
python utils/dashboard/dashboard.py --dir . --debug
260260

261261
# Check browser console for JavaScript errors
262262
# Monitor terminal output for Python exceptions
263263
```
264264

265265
## 📊 Example Analysis Workflow
266266

267-
1. **Start Dashboard**: `python dashboard.py --dir ./benchmark_results`
267+
1. **Start Dashboard**: `python utils/dashboard/dashboard.py --dir ./benchmark_results`
268268
2. **Load Data**: Use directory dropdown to select benchmark data folder
269269
3. **Filter Mechanisms**: Select specific IPC mechanisms to compare
270270
4. **Review Summary**: Analyze performance overview cards and insights

0 commit comments

Comments
 (0)