GSOC20235GUsabilityFinalReport - Revision history

Ggrieco: Update Gitlab MR states

2023-12-01T10:04:38Z

Update Gitlab MR states

← Older revision		Revision as of 10:04, 1 December 2023
Line 64:		Line 64:
	\| 11 \|\| [https://gitlab.com/cttc-lena/nr/-/merge_requests/60 !60 nr-radio-environment-map-helper: Remove unused variable] \|\| Refused \|\| -		\| 11 \|\| [https://gitlab.com/cttc-lena/nr/-/merge_requests/60 !60 nr-radio-environment-map-helper: Remove unused variable] \|\| Refused \|\| -
	\|-		\|-
	\| 12 \|\| [https://gitlab.com/cttc-lena/nr/-/merge_requests/61 !61 cttc-nr-demo: Clarify GridScenarioHelper usage] \|\| ~~In review~~ \|\| [https://gitlab.com/ggrieco/gsoc23-iuns-3/-/tree/main/nr/MR61?ref_type=heads link]		\| 12 \|\| [https://gitlab.com/cttc-lena/nr/-/merge_requests/61 !61 cttc-nr-demo: Clarify GridScenarioHelper usage] \|\| Merged \|\| [https://gitlab.com/ggrieco/gsoc23-iuns-3/-/tree/main/nr/MR61?ref_type=heads link]
	\|-		\|-
	\| 13 \|\| [https://gitlab.com/cttc-lena/nr/-/merge_requests/62 !62 grid-scenario-helper: Add documentation] \|\| In review \|\| [https://gitlab.com/ggrieco/gsoc23-iuns-3/-/tree/main/nr/MR62?ref_type=heads link]		\| 13 \|\| [https://gitlab.com/cttc-lena/nr/-/merge_requests/62 !62 grid-scenario-helper: Add documentation] \|\| In review \|\| [https://gitlab.com/ggrieco/gsoc23-iuns-3/-/tree/main/nr/MR62?ref_type=heads link]
Line 70:		Line 70:
	\| 14 \|\| [https://gitlab.com/cttc-lena/nr/-/merge_requests/63 !63 gitlab-ci: Fix SSL errors on git clone] \|\| Merged \|\| [https://gitlab.com/ggrieco/gsoc23-iuns-3/-/tree/main/nr/merged?ref_type=heads link]		\| 14 \|\| [https://gitlab.com/cttc-lena/nr/-/merge_requests/63 !63 gitlab-ci: Fix SSL errors on git clone] \|\| Merged \|\| [https://gitlab.com/ggrieco/gsoc23-iuns-3/-/tree/main/nr/merged?ref_type=heads link]
	\|-		\|-
	\| 15 \|\| [https://gitlab.com/cttc-lena/nr/-/merge_requests/65 !65 cttc-nr-demo: Usability improvements over Packet Tracing] \|\| ~~In review~~ \|\| [https://gitlab.com/ggrieco/gsoc23-iuns-3/-/tree/main/nr/MR65?ref_type=heads link]		\| 15 \|\| [https://gitlab.com/cttc-lena/nr/-/merge_requests/65 !65 cttc-nr-demo: Usability improvements over Packet Tracing] \|\| Merged \|\| [https://gitlab.com/ggrieco/gsoc23-iuns-3/-/tree/main/nr/MR65?ref_type=heads link]
	\|-		\|-
	\| 16 \|\| [https://gitlab.com/cttc-lena/nr/-/merge_requests/67 !67 cttc-nr-demo: Add references to standards and ns-3 docs] \|\| ~~In review~~ \|\| [https://gitlab.com/ggrieco/gsoc23-iuns-3/-/tree/main/nr/MR67?ref_type=heads link]		\| 16 \|\| [https://gitlab.com/cttc-lena/nr/-/merge_requests/67 !67 cttc-nr-demo: Add references to standards and ns-3 docs] \|\| Merged \|\| [https://gitlab.com/ggrieco/gsoc23-iuns-3/-/tree/main/nr/MR67?ref_type=heads link]
	\|-		\|-
	\| 17 \|\| [https://gitlab.com/cttc-lena/nr/-/merge_requests/68 !68 logs: Demote Informational logs messages to Function trace messages] \|\| ~~In review~~ \|\| [https://gitlab.com/ggrieco/gsoc23-iuns-3/-/tree/main/nr/MR68?ref_type=heads link]		\| 17 \|\| [https://gitlab.com/cttc-lena/nr/-/merge_requests/68 !68 logs: Demote Informational logs messages to Function trace messages] \|\| Merged \|\| [https://gitlab.com/ggrieco/gsoc23-iuns-3/-/tree/main/nr/MR68?ref_type=heads link]
	\|-		\|-
	\| 18 \|\| [https://gitlab.com/cttc-lena/nr/-/merge_requests/71 !71 cttc-nr-demo Tutorial] \|\| ~~In review~~ \|\| [https://gitlab.com/ggrieco/gsoc23-iuns-3/-/tree/main/nr/MR71?ref_type=heads link]. [https://www.nsnam.org/wp-content/uploads/2023/cttc-nr-demo-tutorial-SNAPSHOT-20230911-GSoCFinalReport.pdf compiled PDF]		\| 18 \|\| [https://gitlab.com/cttc-lena/nr/-/merge_requests/71 !71 cttc-nr-demo Tutorial] \|\| Merged \|\| [https://gitlab.com/ggrieco/gsoc23-iuns-3/-/tree/main/nr/MR71?ref_type=heads link]. [https://www.nsnam.org/wp-content/uploads/2023/cttc-nr-demo-tutorial-SNAPSHOT-20230911-GSoCFinalReport.pdf compiled PDF]
	\|}		\|}

Ggrieco at 16:04, 11 September 2023

2023-09-11T16:04:31Z

← Older revision		Revision as of 16:04, 11 September 2023
Line 76:		Line 76:
	\| 17 \|\| [https://gitlab.com/cttc-lena/nr/-/merge_requests/68 !68 logs: Demote Informational logs messages to Function trace messages] \|\| In review \|\| [https://gitlab.com/ggrieco/gsoc23-iuns-3/-/tree/main/nr/MR68?ref_type=heads link]		\| 17 \|\| [https://gitlab.com/cttc-lena/nr/-/merge_requests/68 !68 logs: Demote Informational logs messages to Function trace messages] \|\| In review \|\| [https://gitlab.com/ggrieco/gsoc23-iuns-3/-/tree/main/nr/MR68?ref_type=heads link]
	\|-		\|-
	\| 18 \|\| [https://gitlab.com/cttc-lena/nr/-/merge_requests/71 !71 cttc-nr-demo Tutorial] \|\| In review \|\| [https://gitlab.com/ggrieco/gsoc23-iuns-3/-/tree/main/nr/MR71?ref_type=heads link]. [https://www.nsnam.org/wp-content/uploads/2023/cttc-nr-demo-tutorial-SNAPSHOT-20230911-GSoCFinalReport.pdf compiled ~~version~~]		\| 18 \|\| [https://gitlab.com/cttc-lena/nr/-/merge_requests/71 !71 cttc-nr-demo Tutorial] \|\| In review \|\| [https://gitlab.com/ggrieco/gsoc23-iuns-3/-/tree/main/nr/MR71?ref_type=heads link]. [https://www.nsnam.org/wp-content/uploads/2023/cttc-nr-demo-tutorial-SNAPSHOT-20230911-GSoCFinalReport.pdf compiled PDF]
	\|}		\|}

Ggrieco at 16:04, 11 September 2023

2023-09-11T16:04:15Z

← Older revision		Revision as of 16:04, 11 September 2023
Line 8:		Line 8:
	** [https://www.nsnam.org/mediawiki/index.php?title=GSOC20235GUsability Project wiki page] - used to track the work in progress.		** [https://www.nsnam.org/mediawiki/index.php?title=GSOC20235GUsability Project wiki page] - used to track the work in progress.
	** [https://gitlab.com/ggrieco/gsoc23-iuns-3 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.'''		** [https://gitlab.com/ggrieco/gsoc23-iuns-3 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.'''
			** [https://www.nsnam.org/wp-content/uploads/2023/cttc-nr-demo-tutorial-SNAPSHOT-20230911-GSoCFinalReport.pdf cttc-nr-demo-tutorial-SNAPSHOT-20230911-GSoCFinalReport.pdf] - this is the snapshot of the tutorial made for this GSoC Project.
	** [https://gitlab.com/nsnam/ns-3-dev ns-3-dev Official Repository] - will be referenced in the project.		** [https://gitlab.com/nsnam/ns-3-dev ns-3-dev Official Repository] - will be referenced in the project.
	** [https://gitlab.com/cttc-lena/nr/ nr Official Repository] - used to push MRs in output of this GSoC project.		** [https://gitlab.com/cttc-lena/nr/ nr Official Repository] - used to push MRs in output of this GSoC project.
Line 75:		Line 76:
	\| 17 \|\| [https://gitlab.com/cttc-lena/nr/-/merge_requests/68 !68 logs: Demote Informational logs messages to Function trace messages] \|\| In review \|\| [https://gitlab.com/ggrieco/gsoc23-iuns-3/-/tree/main/nr/MR68?ref_type=heads link]		\| 17 \|\| [https://gitlab.com/cttc-lena/nr/-/merge_requests/68 !68 logs: Demote Informational logs messages to Function trace messages] \|\| In review \|\| [https://gitlab.com/ggrieco/gsoc23-iuns-3/-/tree/main/nr/MR68?ref_type=heads link]
	\|-		\|-
	\| 18 \|\| [https://gitlab.com/cttc-lena/nr/-/merge_requests/71 !71 cttc-nr-demo Tutorial] \|\| In review \|\| [https://gitlab.com/ggrieco/gsoc23-iuns-3/-/tree/main/nr/MR71?ref_type=heads link]		\| 18 \|\| [https://gitlab.com/cttc-lena/nr/-/merge_requests/71 !71 cttc-nr-demo Tutorial] \|\| In review \|\| [https://gitlab.com/ggrieco/gsoc23-iuns-3/-/tree/main/nr/MR71?ref_type=heads link]. [https://www.nsnam.org/wp-content/uploads/2023/cttc-nr-demo-tutorial-SNAPSHOT-20230911-GSoCFinalReport.pdf compiled version]
	\|}		\|}

Line 83:		Line 84:

	# Completing the pending MRs that are currently under review.		# 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.		# Enhancing the [https://www.nsnam.org/wp-content/uploads/2023/cttc-nr-demo-tutorial-SNAPSHOT-20230911-GSoCFinalReport.pdf 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.		# Improving the overall state of documentation and code readability of example scenarios.

Ggrieco at 15:49, 11 September 2023

2023-09-11T15:49:10Z

← Older revision		Revision as of 15:49, 11 September 2023
Line 7:		Line 7:
	* '''Useful links''':		* '''Useful links''':
	** [https://www.nsnam.org/mediawiki/index.php?title=GSOC20235GUsability Project wiki page] - used to track the work in progress.		** [https://www.nsnam.org/mediawiki/index.php?title=GSOC20235GUsability Project wiki page] - used to track the work in progress.
	** [https://gitlab.com/ggrieco/gsoc23-iuns-3 Project patch set repository] - used to archive all the work done for this GSoC		** [https://gitlab.com/ggrieco/gsoc23-iuns-3 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.'''
	** [https://gitlab.com/nsnam/ns-3-dev ns-3-dev Official Repository] - will be referenced in the project.		** [https://gitlab.com/nsnam/ns-3-dev ns-3-dev Official Repository] - will be referenced in the project.
	** [https://gitlab.com/cttc-lena/nr/ nr Official Repository] - used to push MRs in output of this GSoC project.		** [https://gitlab.com/cttc-lena/nr/ nr Official Repository] - used to push MRs in output of this GSoC project.

Ggrieco at 09:19, 10 September 2023

2023-09-10T09:19:48Z

← Older revision		Revision as of 09:19, 10 September 2023
Line 51:		Line 51:
	\| 5 \|\| [https://gitlab.com/cttc-lena/nr/-/merge_requests/54 !54 gitlab-ci-gcc: Fix and upgrade build pipeline] \|\| Merged \|\| [https://gitlab.com/ggrieco/gsoc23-iuns-3/-/tree/main/nr/merged?ref_type=heads link]		\| 5 \|\| [https://gitlab.com/cttc-lena/nr/-/merge_requests/54 !54 gitlab-ci-gcc: Fix and upgrade build pipeline] \|\| Merged \|\| [https://gitlab.com/ggrieco/gsoc23-iuns-3/-/tree/main/nr/merged?ref_type=heads link]
	\|-		\|-
	\| 6 \|\| [https://gitlab.com/cttc-lena/nr/-/merge_requests/55 !55 examples, docs: Update TR 38.900 references to TR 38.901] \|\| Refused \|\| ~~[todo link]~~		\| 6 \|\| [https://gitlab.com/cttc-lena/nr/-/merge_requests/55 !55 examples, docs: Update TR 38.900 references to TR 38.901] \|\| Refused \|\| -
	\|-		\|-
	\| 7 \|\| [https://gitlab.com/cttc-lena/nr/-/merge_requests/56 !56 Readme: Reference the Doxygen tutorial to learn how to run examples] \|\| Merged \|\| [https://gitlab.com/ggrieco/gsoc23-iuns-3/-/tree/main/nr/merged?ref_type=heads link]		\| 7 \|\| [https://gitlab.com/cttc-lena/nr/-/merge_requests/56 !56 Readme: Reference the Doxygen tutorial to learn how to run examples] \|\| Merged \|\| [https://gitlab.com/ggrieco/gsoc23-iuns-3/-/tree/main/nr/merged?ref_type=heads link]
	\|-		\|-
	\| 8 \|\| [https://gitlab.com/cttc-lena/nr/-/merge_requests/57 !57 cttc-nr-demo: Add reference to TS 38.300] \|\| Refused \|\| ~~[todo link]~~		\| 8 \|\| [https://gitlab.com/cttc-lena/nr/-/merge_requests/57 !57 cttc-nr-demo: Add reference to TS 38.300] \|\| Refused \|\| -
	\|-		\|-
	\| 9 \|\| [https://gitlab.com/cttc-lena/nr/-/merge_requests/58 !58 cttc-nr-demo: Add reference to ns-3 logging tutorial] \|\| Refused \|\| ~~[todo link]~~		\| 9 \|\| [https://gitlab.com/cttc-lena/nr/-/merge_requests/58 !58 cttc-nr-demo: Add reference to ns-3 logging tutorial] \|\| Refused \|\| -
	\|-		\|-
	\| 10 \|\| [https://gitlab.com/cttc-lena/nr/-/merge_requests/59 !59 cttc-nr-demo: Add lower-bound frequency check as per TR 39.901] \|\| Merged \|\| [https://gitlab.com/ggrieco/gsoc23-iuns-3/-/tree/main/nr/merged?ref_type=heads link]		\| 10 \|\| [https://gitlab.com/cttc-lena/nr/-/merge_requests/59 !59 cttc-nr-demo: Add lower-bound frequency check as per TR 39.901] \|\| Merged \|\| [https://gitlab.com/ggrieco/gsoc23-iuns-3/-/tree/main/nr/merged?ref_type=heads link]
	\|-		\|-
	\| 11 \|\| [https://gitlab.com/cttc-lena/nr/-/merge_requests/60 !60 nr-radio-environment-map-helper: Remove unused variable] \|\| Refused \|\| ~~[todo link]~~		\| 11 \|\| [https://gitlab.com/cttc-lena/nr/-/merge_requests/60 !60 nr-radio-environment-map-helper: Remove unused variable] \|\| Refused \|\| -
	\|-		\|-
	\| 12 \|\| [https://gitlab.com/cttc-lena/nr/-/merge_requests/61 !61 cttc-nr-demo: Clarify GridScenarioHelper usage] \|\| In review \|\| [https://gitlab.com/ggrieco/gsoc23-iuns-3/-/tree/main/nr/MR61?ref_type=heads link]		\| 12 \|\| [https://gitlab.com/cttc-lena/nr/-/merge_requests/61 !61 cttc-nr-demo: Clarify GridScenarioHelper usage] \|\| In review \|\| [https://gitlab.com/ggrieco/gsoc23-iuns-3/-/tree/main/nr/MR61?ref_type=heads link]

Ggrieco at 09:19, 10 September 2023

2023-09-10T09:19:14Z

Ggrieco: Created page with "= Project Overview = * '''Project Name''': [https://summerofcode.withgoogle.com/programs/2023/projects/oeDFknbT IUNS-3 5G NR: Improving the Usability of ns-3's 5G NR Module]..."

2023-09-09T15:14:15Z

Created page with "= Project Overview = * '''Project Name''': [https://summerofcode.withgoogle.com/programs/2023/projects/oeDFknbT IUNS-3 5G NR: Improving the Usability of ns-3's 5G NR Module]..."

New page

= Project Overview =

* '''Project Name''': [https://summerofcode.withgoogle.com/programs/2023/projects/oeDFknbT 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''':
** [https://www.nsnam.org/mediawiki/index.php?title=GSOC20235GUsability Project wiki page] - used to track the work in progress.
** [https://gitlab.com/nsnam/ns-3-dev ns-3-dev Official Repository] - will be referenced in the project.
** [https://gitlab.com/cttc-lena/nr/ 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 <code>cttc-nr-demo</code>.
# 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: [https://gitlab.com/ggrieco/ns-3-dev ggrieco/ns-3-dev] and [https://gitlab.com/ggrieco/nr ggrieco/nr].
* Analyzed the <code>cttc-nr-demo</code> example 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 [https://www.nsnam.org/research/wns3/wns3-2023/program/ WNS3 2023], gathering interesting feedback from the ns-3 community.
* Created a tutorial to better understand how the NR module works, based on <code>cttc-nr-demo</code> example.
* 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:

{| class="wikitable"
|+ Merge Requests
|-
! No. !! Name !! Status !! Archived Patchset
|-
| 1 || [https://gitlab.com/cttc-lena/nr/-/merge_requests/50 !50 docs: Update sqlite support message] || Merged || [todo link]
|-
| 2 || [https://gitlab.com/cttc-lena/nr/-/merge_requests/51 !51 nr-helper: Drop undefined method] || Merged || [todo link]
|-
| 3 || [https://gitlab.com/cttc-lena/nr/-/merge_requests/52 !52 Example Usability Improvements] || In review || [todo link]
|-
| 4 || [https://gitlab.com/cttc-lena/nr/-/merge_requests/53 !53 examples: Fix CommandLine declaration for doxygen] || Merged || [todo link]
|-
| 5 || [https://gitlab.com/cttc-lena/nr/-/merge_requests/54 !54 gitlab-ci-gcc: Fix and upgrade build pipeline] || Merged || [todo link]
|-
| 6 || [https://gitlab.com/cttc-lena/nr/-/merge_requests/55 !55 examples, docs: Update TR 38.900 references to TR 38.901] || Refused || [todo link]
|-
| 7 || [https://gitlab.com/cttc-lena/nr/-/merge_requests/56 !56 Readme: Reference the Doxygen tutorial to learn how to run examples] || Merged || [todo link]
|-
| 8 || [https://gitlab.com/cttc-lena/nr/-/merge_requests/57 !57 cttc-nr-demo: Add reference to TS 38.300] || Refused || [todo link]
|-
| 9 || [https://gitlab.com/cttc-lena/nr/-/merge_requests/58 !58 cttc-nr-demo: Add reference to ns-3 logging tutorial] || Refused || [todo link]
|-
| 10 || [https://gitlab.com/cttc-lena/nr/-/merge_requests/59 !59 cttc-nr-demo: Add lower-bound frequency check as per TR 39.901] || Merged || [todo link]
|-
| 11 || [https://gitlab.com/cttc-lena/nr/-/merge_requests/60 !60 nr-radio-environment-map-helper: Remove unused variable] || Refused || [todo link]
|-
| 12 || [https://gitlab.com/cttc-lena/nr/-/merge_requests/61 !61 cttc-nr-demo: Clarify GridScenarioHelper usage] || In review || [todo link]
|-
| 13 || [https://gitlab.com/cttc-lena/nr/-/merge_requests/62 !62 grid-scenario-helper: Add documentation] || In review || [todo link]
|-
| 14 || [https://gitlab.com/cttc-lena/nr/-/merge_requests/63 !63 gitlab-ci: Fix SSL errors on git clone] || Merged || [todo link]
|-
| 15 || [https://gitlab.com/cttc-lena/nr/-/merge_requests/65 !65 cttc-nr-demo: Usability improvements over Packet Tracing] || In review || [todo link]
|-
| 16 || [https://gitlab.com/cttc-lena/nr/-/merge_requests/67 !67 cttc-nr-demo: Add references to standards and ns-3 docs] || In review || [todo link]
|-
| 17 || [https://gitlab.com/cttc-lena/nr/-/merge_requests/68 !68 logs: Demote Informational logs messages to Function trace messages] || In review || [todo link]
|-
| 18 || [https://gitlab.com/cttc-lena/nr/-/merge_requests/71 !71 cttc-nr-demo Tutorial] || In review || [todo link]
|}

= 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)