Repository navigation
docs: review fixes, demo verification, and documentation overhaul - #10
Open
raghavnaidu1470-dotcom wants to merge 7 commits into
Open
raghavnaidu1470-dotcom wants to merge 7 commits into
raghavnaidu1470-dotcom wants to merge 7 commits into
Conversation
…c profiles, resilience flow, and race mode comparison
…es across documentation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary of Changes
This pull request implements the review fixes requested in the NetSim-X specification overhaul:
1. Name Change
README.md,GETTING_STARTED.md,CONTRIBUTING.md,CODEOWNERS,STATUS.md,docs/*.md,network/__init__.py, and test files).raghavnaidu1470-dotcomand teammatesHarish(Member 2) andAkhilesh Reddy(Member 3).2. Dijkstra Demo Consistency
README.md,docs/spec.md,docs/member1_network_engine.md, anddata/topologies/why_shortest_is_not_best.jsonto explicitly designate Dijkstra (hop-count metric).36.0 ms), illustrating the classic shortest-hop-path pitfall.test_dijkstra_why_shortest_is_not_best_hop_vs_latencyverifying both metrics.3. Verified README Numbers for All 3 Demos
PC1 -> R1 -> R2 -> R5 -> PC2(4 hops, 79.0 ms, 82.0% congestion, 19.17% loss). XAR / Latency Dijkstra yieldsPC1 -> R1 -> R3 -> R4 -> R5 -> PC2(5 hops, 36.0 ms, 12.0% congestion, 3.16% loss).PC1 -> R1 -> R2 -> PC2(3 hops, 14.0 ms, 10.0% congestion, 0.70% loss). Post-failure route isPC1 -> R1 -> R3 -> R4 -> PC2(4 hops, 44.0 ms, 15.0% congestion, 2.58% loss, recovery time: 350.0 ms).PC1 -> R1 -> R3 -> R4 -> PC2, 17.0 ms, 14.0% congestion, 14.61% loss, XAR score: 0.1458 vs 0.2085) selected for Real-Time traffic. Candidate B (PC1 -> R1 -> R2 -> R4 -> PC2, 69.0 ms, 8.0% congestion, 0.40% loss, XAR score: 0.0826 vs 0.1654) selected for Reliable Data traffic.4. CI Workflow
.github/workflows/test.ymlauthored and verified locally for Python 3.11 / 3.12 running pytest.workflowscope, preventing remote pushes that add or alter files under.github/workflows/. Rungh auth refresh -s workflowor create the workflow in GitHub web UI to trigger Actions.5. Math Rendering
README.mdanddocs/*.mdby escaping underscores in LaTeX\text{}and\mathrm{}blocks.6. Repository About Section
gh repo edit:Explainable adaptive routing and network resilience simulator (Python, NetworkX, Streamlit)computer-networks,routing,networkx,streamlit,network-simulation,dijkstra,distance-vector,python7. README Enhancements
8. STATUS.md Honesty Pass
Member 1 (implemented)vsScaffolded (AI) - owner to review and extend.Scaffolded - pending owner review.9. Documentation Cross-Check