Merge pull request #3 from muditbhargava66/v1.4.1

Release v1.4.1: REST API Framework and Jupyter Dashboard

Author: muditbhargava66

CHANGELOG.md

@@ -5,6 +5,70 @@ All notable changes to the SerDes Validation Framework will be documented in thi
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.4.1] - 2025-07-28
+
+### Added
+- **REST API Framework** 🌐
+  - Complete FastAPI-based REST API for remote access
+  - Eye diagram analysis endpoints with mask compliance checking
+  - Waveform analysis and signal quality assessment
+  - Asynchronous stress testing with real-time status monitoring
+  - Test fixture control and environmental monitoring
+  - System status and health monitoring endpoints
+  - Comprehensive request/response models with validation
+  - CLI client for command-line API interaction
+  - OpenAPI/Swagger documentation at `/docs`
+  - CORS and compression middleware support
+
+- **Loopback Stress Testing** 🔄
+  - Complete loopback stress test implementation (TX → RX → back to TX)
+  - Progressive signal degradation simulation over multiple cycles
+  - Automatic eye height, jitter, and SNR tracking
+  - CSV logging for cycle-by-cycle data analysis
+  - Interactive plots showing degradation trends over time
+  - Configurable thresholds for pass/fail criteria
+  - Support for all protocols (USB4, PCIe, Ethernet)
+  - Waveform saving for failed cycles
+  - Comprehensive logging and error handling
+
+### Enhanced
+- **Dual Stress Testing Systems** 🆕
+  - **Loopback Stress Testing Module** (`stress_testing/`)
+    - `LoopbackStressTest` class for automated stress testing
+    - `StressTestConfig` for flexible test configuration
+    - `StressTestResults` with comprehensive metrics and statistics
+    - Progressive degradation modeling with realistic effects
+    - Multi-protocol support with protocol-specific parameters
+  - **USB4-Specific Stress Testing** (`protocols/usb4/stress_testing.py`)
+    - `USB4StressTester` for protocol-aware stress scenarios
+    - Thermal stress testing with temperature monitoring
+    - Error injection and recovery testing
+    - Power cycling and bandwidth saturation stress
+    - Multi-device stress testing capabilities
+
+- **Jupyter Dashboard Module** (`jupyter_dashboard/`) 🆕
+  - `EyeDiagramDashboard` for interactive eye diagram visualization
+  - `WaveformAnalyzer` for comprehensive signal analysis
+  - `InteractivePlotter` with real-time controls and widgets
+  - Support for captured waveforms and pass/fail annotations
+  - Multi-lane analysis with protocol-specific features
+  - Professional visualizations with matplotlib and plotly
+  - Export capabilities for results and plots
+
+### Scripts & Examples
+- **`scripts/run_loopback_stress_test.py`**: Command-line stress testing tool
+- **`examples/loopback_stress_test_example.py`**: Comprehensive usage examples
+- **`examples/jupyter_dashboard_example.py`**: Jupyter dashboard demonstration 🆕
+- **`examples/jupyter_eye_diagram_dashboard.ipynb`**: Interactive Jupyter notebook 🆕
+- Support for quick tests, protocol comparison, and CSV analysis
+- Interactive dashboard examples with multi-protocol support
+
+### Performance
+- Efficient signal generation with configurable degradation models
+- Optimized for long-running tests (1000+ cycles)
+- Memory-efficient waveform processing
+- Real-time progress monitoring and logging
+
 ## [1.4.0] - 2025-07-27
 
 ### Added

README.md

@@ -2,7 +2,7 @@
 
 # 🚀 SerDes Validation Framework
 
-![serdes-validation-framework Version](https://img.shields.io/badge/version-1.4.0-blue)
+![serdes-validation-framework Version](https://img.shields.io/badge/version-1.4.1-blue)
 ![Production Ready](https://img.shields.io/badge/status-production%20ready-brightgreen)
 [![CI](https://github.com/muditbhargava66/serdes-validation-framework/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/muditbhargava66/serdes-validation-framework/actions/workflows/ci.yml)
 [![Lint](https://github.com/muditbhargava66/serdes-validation-framework/actions/workflows/lint.yml/badge.svg?branch=main)](https://github.com/muditbhargava66/serdes-validation-framework/actions/workflows/lint.yml)
@@ -32,7 +32,37 @@
 - 🎛️ **Universal Instrument Control:** GPIB/USB interface for multi-vendor support
 - 📋 **Flexible Test Sequences:** Customizable, reusable test automation
 
-### 🆕 Latest Features in v1.4.0
+### 🆕 Latest Features in v1.4.1
+- 🌐 **REST API Framework:** Complete web API for remote access and integration
+  - **FastAPI-based REST API:** Modern, async API with automatic OpenAPI documentation
+  - **Eye Diagram Analysis:** Remote eye diagram analysis with mask compliance checking
+  - **Waveform Analysis:** Signal quality assessment via HTTP endpoints
+  - **Stress Testing API:** Asynchronous stress test execution with real-time monitoring
+  - **Test Fixture Control:** Remote control of test equipment and environmental monitoring
+  - **CLI Client:** Command-line interface for API interaction
+  - **Interactive Documentation:** Swagger UI at `/docs` for API exploration
+
+- 🔄 **Dual Stress Testing Systems:** Comprehensive stress testing with two complementary approaches
+  - **Loopback Stress Testing:** General-purpose TX → RX → TX simulation with progressive degradation tracking
+    - Multi-cycle testing (1000+ cycles) with real-time monitoring
+    - Signal quality tracking over time (eye height, jitter, SNR, BER)
+    - CSV data export and interactive plots
+    - Multi-protocol support (USB4, PCIe, Ethernet)
+  - **USB4-Specific Stress Testing:** Protocol-aware stress scenarios for USB4/Thunderbolt
+    - Thermal stress testing with temperature monitoring
+    - Error injection and recovery testing
+    - Power cycling and bandwidth saturation stress
+    - Multi-device stress testing scenarios
+
+- 📊 **Jupyter Dashboard System:** Interactive eye diagram visualization in Jupyter notebooks
+  - **Captured Waveform Analysis:** Direct integration with SVF analyzers
+  - **Eye Diagram Dashboards:** Professional-grade eye diagram visualization
+  - **Pass/Fail Annotations:** Automatic measurement annotations from SVF
+  - **Interactive Controls:** Real-time parameter adjustment with widgets
+  - **Multi-Protocol Support:** USB4, PCIe, Ethernet dashboard templates
+  - **Export Capabilities:** Save results and plots in multiple formats
+
+### 🔥 Major Features in v1.4.0
 - 🔌 **Complete USB4/Thunderbolt 4 Support:** Full 40 Gbps dual-lane validation with tunneling protocols
 - 🔒 **Thunderbolt 4 Certification Suite:** Intel-compliant certification with security validation and DMA protection
 - 🌐 **Multi-Protocol Tunneling:** PCIe, DisplayPort, and USB 3.2 tunneling validation with integrity checking
@@ -382,6 +412,29 @@ bandwidth_result = viz.plot_tunnel_bandwidth(
 )
 ```
 
+#### Loopback Stress Testing (NEW in v1.4.1)
+```python
+from serdes_validation_framework.stress_testing import LoopbackStressTest, create_stress_test_config
+
+# Create stress test configuration
+config = create_stress_test_config(
+    protocol="USB4",
+    num_cycles=1000,
+    output_dir="usb4_stress_results"
+)
+
+# Run stress test
+stress_test = LoopbackStressTest(config)
+results = stress_test.run_stress_test()
+
+# Analyze results
+print(f"Success Rate: {results.success_rate:.1%}")
+print(f"Max Degradation: {results.max_degradation:.1f}%")
+print(f"Final Eye Height: {results.final_eye_height:.4f}V")
+
+# Results automatically saved to CSV and plots generated
+```
+
 #### Traditional Test Sequencer
 ```python
 from serdes_validation_framework.test_sequence import PCIeTestSequencer
@@ -406,6 +459,66 @@ results = sequencer.run_sequence([
 print(f"Test completed: {results['status']}")
 ```
 
+#### REST API Usage (NEW in v1.4.1)
+```python
+# Start the API server
+from serdes_validation_framework.api import create_app
+import uvicorn
+
+app = create_app()
+uvicorn.run(app, host="0.0.0.0", port=8000)
+
+# Or use the CLI
+# python -m serdes_validation_framework.api.cli server --host 0.0.0.0 --port 8000
+```
+
+```python
+# Use the API client
+import requests
+import numpy as np
+
+# Analyze eye diagram via API
+signal_data = np.random.randn(1000) * 0.4
+response = requests.post("http://localhost:8000/api/v1/eye-diagram/analyze", json={
+    "signal_data": signal_data.tolist(),
+    "sample_rate": 40e9,
+    "protocol": "USB4",
+    "show_mask": True
+})
+
+result = response.json()
+print(f"Eye Height: {result['eye_height']:.4f}V")
+print(f"Q-Factor: {result['q_factor']:.2f}")
+print(f"Mask Compliance: {result['mask_analysis']['compliance_level']}")
+
+# Start stress test asynchronously
+stress_response = requests.post("http://localhost:8000/api/v1/stress-test/start", json={
+    "protocol": "USB4",
+    "num_cycles": 100,
+    "cycle_duration": 1.0
+})
+
+test_id = stress_response.json()["test_id"]
+
+# Monitor test progress
+status_response = requests.get(f"http://localhost:8000/api/v1/test/{test_id}/status")
+print(f"Test Status: {status_response.json()['status']}")
+```
+
+```bash
+# Use the CLI client
+python -m serdes_validation_framework.api.cli analyze-eye \
+    --signal-file signal_data.csv \
+    --protocol USB4 \
+    --sample-rate 40e9 \
+    --output results.json
+
+python -m serdes_validation_framework.api.cli start-stress-test \
+    --protocol PCIe \
+    --cycles 500 \
+    --duration 2.0
+```
+
 ## 📁 Examples & Scripts
 
 ### 🎯 Interactive Examples

docs/README.md

@@ -1,6 +1,6 @@
-# Documentation
+# Documentation v1.4.1
 
-This directory contains the documentation for the SerDes Validation Framework.
+This directory contains the comprehensive documentation for the SerDes Validation Framework, including new REST API and Jupyter Dashboard documentation.
 
 ## Building the Documentation
 
@@ -23,7 +23,8 @@ This directory contains the documentation for the SerDes Validation Framework.
 
 ```
 docs/
-├── api/                       # API documentation
+├── api/                       # 🆕 Enhanced API documentation (v1.4.1)
+│   ├── rest-api.md           # 🆕 Complete REST API reference
 │   ├── index.md
 │   ├── mock_controller.md     # Mock controller docs
 │   ├── instrument_control.md  # Instrument control docs
@@ -34,29 +35,51 @@ docs/
 │   ├── mock_testing.md       # Mock testing tutorial
 │   ├── 224g_validation.md    # 224G validation guide
 │   └── pam4_analysis.md      # PAM4 analysis guide
-├── guides/                    # User guides
+├── guides/                    # 🆕 Enhanced user guides (v1.4.1)
 │   ├── installation.md      # Installation guide
-│   ├── testing.md          # Comprehensive testing guide (91+ tests)
+│   ├── testing.md          # Comprehensive testing guide (130+ tests)
 │   ├── troubleshooting.md   # Troubleshooting guide
-│   └── cicd.md             # CI/CD integration guide
-├── examples/                  # Code examples
+│   ├── cicd.md             # CI/CD integration guide
+│   ├── jupyter_dashboard_guide.md  # 🆕 Jupyter Dashboard guide
+│   └── stress_testing_overview.md  # 🆕 Stress testing guide
+├── examples/                  # 🆕 Enhanced code examples (v1.4.1)
+│   ├── api_examples.md       # 🆕 REST API usage examples
 │   ├── mock_controller_examples.md
 │   ├── testing_examples.md
 │   ├── protocol_detection_examples.md
 │   └── integration_testing_examples.md
-├── CHANGELOG.md             # Detailed changelog with v1.4.0 improvements
+├── CHANGELOG.md             # 🆕 Detailed changelog with v1.4.1 improvements
 ├── CONTRIBUTING.md          # Contribution guide
 ├── INSTALL.md              # Installation guide
-└── USAGE.md                # Usage guide
+└── USAGE.md                # 🆕 Updated usage guide with API examples
 ```
 
+## 🆕 New Documentation in v1.4.1
+
+### REST API Documentation
+- **Complete API Reference** (`api/rest-api.md`) - All 8 endpoints documented
+- **Usage Examples** (`examples/api_examples.md`) - Comprehensive API usage patterns
+- **Interactive Documentation** - Available at `/docs` when API server is running
+
+### Jupyter Dashboard Documentation
+- **Dashboard Guide** (`guides/jupyter_dashboard_guide.md`) - Interactive eye diagram analysis
+- **Usage Examples** - Multi-protocol dashboard examples
+- **Integration Guide** - How to integrate with existing workflows
+
+### Stress Testing Documentation
+- **Stress Testing Overview** (`guides/stress_testing_overview.md`) - Dual stress testing systems
+- **Loopback Testing** - Progressive degradation simulation
+- **USB4-Specific Testing** - Protocol-aware stress scenarios
+
 ## Documentation Standards
 
 1. Use Markdown syntax
 2. Include type hints in code examples
 3. Validate floating-point numbers
 4. Provide clear error messages
 5. Include example usage
+6. 🆕 Include API endpoint documentation with request/response examples
+7. 🆕 Provide interactive dashboard usage patterns
 
 ## Adding New Documentation
 

docs/USAGE.md

@@ -48,6 +48,75 @@ report_path = reporter.generate_compliance_report(session.session_id)
 print(f"Report generated: {report_path}")
 ```
 
+### 3. REST API Usage (NEW in v1.4.1)
+
+#### Starting the API Server
+
+```bash
+# Start the API server
+python -m serdes_validation_framework.api.cli server --host 0.0.0.0 --port 8000
+
+# Or use the run script
+python run_api_server.py
+```
+
+#### Using the API
+
+```python
+import requests
+import numpy as np
+
+# API base URL
+BASE_URL = "http://localhost:8000/api/v1"
+
+# Generate test signal
+signal_data = np.random.randn(1000) * 0.4
+
+# Analyze eye diagram via API
+response = requests.post(f"{BASE_URL}/eye-diagram/analyze", json={
+    "signal_data": signal_data.tolist(),
+    "sample_rate": 40e9,
+    "protocol": "USB4",
+    "show_mask": True
+})
+
+if response.status_code == 200:
+    result = response.json()
+    print(f"Eye Height: {result['eye_height']:.4f}V")
+    print(f"Q-Factor: {result['q_factor']:.2f}")
+    print(f"Mask Compliance: {result['mask_analysis']['compliance_level']}")
+
+# Start stress test
+stress_response = requests.post(f"{BASE_URL}/stress-test/start", json={
+    "protocol": "USB4",
+    "num_cycles": 100,
+    "cycle_duration": 1.0
+})
+
+test_id = stress_response.json()["test_id"]
+print(f"Started stress test: {test_id}")
+```
+
+#### CLI Client Usage
+
+```bash
+# Analyze eye diagram
+python -m serdes_validation_framework.api.cli analyze-eye \
+    --signal-file signal_data.csv \
+    --protocol USB4 \
+    --sample-rate 40e9 \
+    --output results.json
+
+# Start stress test
+python -m serdes_validation_framework.api.cli start-stress-test \
+    --protocol PCIe \
+    --cycles 500 \
+    --duration 2.0
+
+# Get system status
+python -m serdes_validation_framework.api.cli status
+```
+
 ### 3. Mock Mode for Development
 
 ```python