Skip to content

docs: add comprehensive codebase documentation#1

Merged
AaravWayneBanner merged 1 commit into
AaravWayneBanner:mainfrom
RudraDudhat2509:docs/codebase-documentation
May 23, 2026
Merged

docs: add comprehensive codebase documentation#1
AaravWayneBanner merged 1 commit into
AaravWayneBanner:mainfrom
RudraDudhat2509:docs/codebase-documentation

Conversation

@RudraDudhat2509

@RudraDudhat2509 RudraDudhat2509 commented May 23, 2026

Copy link
Copy Markdown

Summary

This PR adds thorough documentation covering the entire codebase, every module, formula, and design decision explained in plain English alongside the math.

  • README.md : Updated with scenario table, links to all docs, quick start
  • ARCHITECTURE.md : Full directory map, module dependencies, two-version comparison (draft vs. active fast fading), global parameter table
  • FAST_FADING_PIPELINE.md : The complete 12-step 3GPP TR 38.901 GBSM process with formula derivations, code references, and a documented list of known bugs/TODOs
  • PATHLOSS_AND_LOS.md : Every path loss formula (RMa, UMa, UMi, InH, InF) with LOS probability models and the V2I baseline models in ChannelModel.py
  • ADDITIONAL_COMPONENTS.md :All optional extensions: spatial consistency, blockage model B, oxygen absorption, dual mobility, UT rotation, large bandwidth, ATOA, CDL-A/B/C/D/E, Rician fading (Rice class)
  • PHYSICAL_TO_APPLICATION.md :The latency/PRR simulator with 5G NR numerology background, resource scheduling logic, and link-level assumption checklist

Test plan

  • [ x] Verify all file links in README.md resolve correctly
  • Check that formula notation matches 3GPP TR 38.901 V17.0.0 tables
  • Confirm no existing source files were modified

Add 5 markdown files covering the full 3GPP TR 38.901 implementation:
- README.md: updated with scenario table, doc index, and quick start
- ARCHITECTURE.md: directory map, module dependencies, execution flow
- FAST_FADING_PIPELINE.md: 12-step GBSM process with code references and known bugs
- PATHLOSS_AND_LOS.md: all path loss formulas and LOS probability models
- ADDITIONAL_COMPONENTS.md: blockage, spatial consistency, oxygen absorption, dual mobility, CDL models, Rician fading
- PHYSICAL_TO_APPLICATION.md: latency/PRR simulator and 5G NR resource grid background

Co-Authored-By: Rudra Dudhat <[email protected]>
@AaravWayneBanner
AaravWayneBanner merged commit 55aa693 into AaravWayneBanner:main May 23, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants