GSOC20235GUsabilityFinalReport
From Nsnam
Contents
Project Overview
- Project Name: IUNS-3 5G NR: Improving the Usability of ns-3's 5G NR Module
- Contributor: Giovanni Grieco
- Mentors: Tom Henderson, Katerina Koutlia, and Biljana Bojovic
- Main Goal: The primary objective of this project was to enhance the user-friendliness of the 5G NR module within ns-3. This was achieved by providing an inviting user experience and a detailed tutorial that is specifically designed to help users understand the inner workings of a simulated 5G Radio Access Network (RAN) during their initial usage.
- Useful links:
- Project wiki page - used to track the work in progress.
- Project patch set repository - used to archive all the work done for this GSoC. If you are a reviewer, follow this link to check all the code done.
- cttc-nr-demo-tutorial-SNAPSHOT-20230911-GSoCFinalReport.pdf - this is the snapshot of the tutorial made for this GSoC Project.
- ns-3-dev Official Repository - will be referenced in the project.
- nr Official Repository - used to push MRs in output of this GSoC project.
Milestones
- Provide a description of how packets flow through the 5G NR RAN. Be able to answer the question "what happens to the traffic between a gNB and a UE?"
- Improve or add documentation when necessary, in order to address usability issues in understanding fundamental example scenarios, such as
cttc-nr-demo. - Enhance packet/frame tracing capabilities by offering flexible log messages and trace sources.
- Review and refactor code to improve clarity on example scenarios.
- Be able to measure latency at different layers of the NR stack.
Activities
- ns-3-dev and NR were forked at their respective versions: 3.39 and 2.5.x, creating the following two personal repositories: ggrieco/ns-3-dev and ggrieco/nr.
- Analyzed the
cttc-nr-demoexample for usability issues. - Helped mentors in fixing pipeline configuration issues, hindering the correct checking of build and code style.
- Presented work being done and merged over the NR module at WNS3 2023, gathering interesting feedback from the ns-3 community.
- Created a tutorial to better understand how the NR module works, based on
cttc-nr-demoexample. - Various documentation and log improvements tracked by MRs.
Deviations
The project focused on milestones different from the ones listed in the starting project idea after internal meetings with mentors and feedback gathered during the Community Bonding Period.
Merge Requests
All the following activities can be easily reviewed on the following MRs:
Future Works
Since the milestones are flexible and subject to continuous enhancement, future efforts can be directed towards:
- Completing the pending MRs that are currently under review.
- Enhancing the tutorial to provide clearer explanations for certain aspects of the simulation, particularly those pertaining to the MAC and PHY layers, in order to align more effectively with the stated milestones.
- Improving the overall state of documentation and code readability of example scenarios.
Acronyms
- Centre Tecnològic de Telecomunicacions de Catalunya (CTTC)
- Google Summer of Code (GSoC)
- Medium Access Control (MAC)
- Merge Request (MR)
- New Radio (NR)
- Next Generation Node-B (gNB)
- Radio Access Network (RAN)
- User Equipment (UE)
- Workshop on ns-3 (WNS3)
