- Getting Started Guide
- GCI timeline
- GCI Frequently Asked Questions
- Student Responsibilities
- Mentor Responsibilities
- Get in contact with the ns-3 team: ns-developers mailing list | Chat https://ns-3.zulipchat.com/
ns-3's GCI 2019
This webpage highlights ns-3's Google Code-In 2019 effort. Google Code-In is an annual contest sponsored by Google to introduce pre-university students to open source software projects.
The seven week coding period for projects will run from December 2, 2019 to January 23, 2020. The full project timeline is here: https://developers.google.com/open-source/gci/timeline
About the ns-3 project
ns-3 is a discrete-event network simulator, with a particular emphasis on network research and education.
Users of ns-3 can construct simulations of computer networks using models of traffic generators, protocols such as TCP/IP, and devices and channels such as WiFi, and analyze or visualize the results. Simulation plays a vital role in the research and education process, because of the ability for simulations to obtain reproducible results (particularly for wireless protocol design), scale to large networks, and study systems that have not yet been implemented. A particular emphasis in ns-3 is the high degree of realism in the models (including frameworks for real application and kernel code) and integration of the tool with virtual machine environments and testbeds; we view that researchers need to move more effortlessly between simulation, testbeds, and live experiments, and ns-3 is designed to facilitate that.
Mentors will keep track of the students work and provide them constructive feedback. Mentors from companies are welcome, if the employer will permit the mentor sufficient time to perform the mentoring. Prospective mentors should notify Mohit P. Tahiliani or Tom Henderson of interest. Mentors familiar with ns-3 development practices will be preferred, to improve the chances of student code merge.
Students: how to participate
For students interested in applying to ns-3 for GCI, first wait to see if ns-3 will be selected. If so, then go through the following list to get started:
- Read how GCI works.
- Read the official Getting Started Guide.
- Look through our List of tasks which will be visible through the GCI dashboard once the program starts on December 2, 2019.
- Select appropriate tasks from the following categories: coding, documentation, training, outreach, research, quality assurance, and design.
- Glance through the ns-3 tutorial, if you have not already done so.
- Proceed to get in touch with the mentors: ns-developers mailing list | Chat https://ns-3.zulipchat.com/
Mentors: how to participate
The ns-3 project is open to the proposal of new tasks by developers interested in being a GCI mentor. For mentors who're adding tasks to the list below, please ensure that:
- The tasks must be sized such that they can be completed in 3 - 5 hours by students. Students have 3 days to complete the tasks.
- The tasks must belong to any one of the following categories: coding, documentation, training, outreach, research, quality assurance, and design, and the respective category must be specified clearly in the description of the task. Note that tasks must not be related to language translation of the project documentation.
- The task must be sufficiently described i.e., the main aim of the task, complexity of the task, reference links and other relevant information.
- The tasks must be related to any of the following: ns-3-dev, ns-3-dce, ns-3 app store, ns-3 wiki and bake.
List of mentors
The list of mentors for GCI 2019 (more to be added):
- Tom Henderson
- Peter Barnes
- Mohit P. Tahiliani
- Manasa Rangarer
- Michele Polese
- Ankit Deepak
- Abhijith Anilkumar
- Vivek Jain
- Viyom Mittal
- Apoorva Bhargava
- Shefali Gupta
- Aarti Nandagiri
- Vishal Rathod
- Harsh Patel
- Vilas Bhat
- Padmini Gaur
- Mishal Shah
- Shreyansh Srivastava
- Athreya H. Nagaraj
- Gokul Bargaje
- Avinash Kumar
- Margi Pansiniya
- Ananthakrishnan Saji
- Ajumal Abdul Majeed
- Archit Pandey
- Tarun Anand
- Sanjana Krishnam
Code and Documentation contributions to ns-3
While the emphasis on GCI is the contest, some of the work that the students provide may be work that can be merged to the open source project's code or documentation. Also, due to the nature of the contest, some tasks will be completed successfully by multiple students. If the ns-3 project wishes to merge any work products after the GCI contest ends, ns-3 may select from these work products and will follow any applicable Google policies as well as ns-3 policies about code contribution and licensing. In general, ns-3 code contributions will typically be licensed with the GPLv2 license, and copyright stays with the author. ns-3 documentation contributions will typically be licensed with CC BY-SA 4.0 license.