GSOC2011StudentGuide - Revision history

Vedranm: Vedranm moved page GS02011StudentGuide to GSOC2011StudentGuide: Wiki page name cleanup

2013-02-10T16:58:41Z

Vedranm moved page GS02011StudentGuide to GSOC2011StudentGuide: Wiki page name cleanup

← Older revision	Revision as of 16:58, 10 February 2013
(No difference)

Tomh: remove gsoc flyer link

2011-04-10T17:45:13Z

remove gsoc flyer link

← Older revision		Revision as of 17:45, 10 April 2011
Line 9:		Line 9:
	* [[GSOC2009Projects \|GSoC 2009 Ideas page]] \| [[GSOC2009AcceptedProjects \|GSoC 2009 Accepted Projects]]		* [[GSOC2009Projects \|GSoC 2009 Ideas page]] \| [[GSOC2009AcceptedProjects \|GSoC 2009 Accepted Projects]]
	* [[GSOC2010OAReport \|GSoC Organization Administrator guide]]		* [[GSOC2010OAReport \|GSoC Organization Administrator guide]]
			<!--
	* [[Media:ns3GSOC2011Flyer.jpg \| ns3's GSoC 2011 Flyer]]		* [[Media:ns3GSOC2011Flyer.jpg \| ns3's GSoC 2011 Flyer]]
			-->
	* ''Get in contact with the ns-3 team'': [http://mailman.isi.edu/mailman/listinfo/ns-developers ns-developers mailing list] \| ''IRC'' #ns-3 on freenode.net		* ''Get in contact with the ns-3 team'': [http://mailman.isi.edu/mailman/listinfo/ns-developers ns-developers mailing list] \| ''IRC'' #ns-3 on freenode.net

Tomh: /* Student Guidelines */

2011-04-10T17:44:03Z

Student Guidelines

← Older revision		Revision as of 17:44, 10 April 2011
Line 16:		Line 16:
	= Student Guidelines =		= Student Guidelines =

	This webpage highlights the expectations and requirements for student applicants for ns-3's Summer of Code 2011 effort.<br/>		This webpage highlights the expectations and requirements for student applicants for ns-3's Summer of Code (NSoC) 2011 effort. These guidelines follow those that we have used in past years for the [http://code.google.com/soc/ Google Summer of Code], but readers should be aware that the 2011 program is not affiliated with Google (since we were not selected this year for GSoC), and that in particular, no student or mentor funding is associated with NSoC.<br/>

	== Project Expectations ==		== Project Expectations ==
Line 76:		Line 76:
	== Additional information about ns-3 ==		== Additional information about ns-3 ==

	Additional slides about the ns-3 GSoC project (from ~~last year~~) are also available, from a [http://www.nsnam.org/docs/gsoc.ppt GSoC Infosession] at the University of Washington on March 5th, 2009.		Additional slides about the ns-3 GSoC project (from 2009) are also available, from a [http://www.nsnam.org/docs/gsoc.ppt GSoC Infosession] at the University of Washington on March 5th, 2009.

	[[Category:NSoC]]		[[Category:NSoC]]

Lalith at 18:59, 29 March 2011

2011-03-29T18:59:27Z

← Older revision		Revision as of 18:59, 29 March 2011
Line 4:		Line 4:

	* [[GS02011StudentGuide \|ns-3 GSoC/NSoC Student guide]]		* [[GS02011StudentGuide \|ns-3 GSoC/NSoC Student guide]]
	* [[~~NS02011StudentApplicationTemplate~~ \|NSoC Student application template]]		* [[GS02011StudentApplicationTemplate \|NSoC Student application template]]
	* [[GSOC2011Projects \|NSoC 2011 Ideas page]]		* [[GSOC2011Projects \|NSoC 2011 Ideas page]]
	* [[GSOC2010Projects \|GSoC 2010 Ideas page]] \| [[GSOC2010AcceptedProjects \|GSoC 2010 Accepted Projects]]		* [[GSOC2010Projects \|GSoC 2010 Ideas page]] \| [[GSOC2010AcceptedProjects \|GSoC 2010 Accepted Projects]]

Lalith at 18:58, 29 March 2011

2011-03-29T18:58:24Z

← Older revision		Revision as of 18:58, 29 March 2011
Line 4:		Line 4:

	* [[GS02011StudentGuide \|ns-3 GSoC/NSoC Student guide]]		* [[GS02011StudentGuide \|ns-3 GSoC/NSoC Student guide]]
	* [[~~GS02011StudentApplicationTemplate~~ \|NSoC Student application template]]		* [[NS02011StudentApplicationTemplate \|NSoC Student application template]]
	* [[GSOC2011Projects \|NSoC 2011 Ideas page]]		* [[GSOC2011Projects \|NSoC 2011 Ideas page]]
	* [[GSOC2010Projects \|GSoC 2010 Ideas page]] \| [[GSOC2010AcceptedProjects \|GSoC 2010 Accepted Projects]]		* [[GSOC2010Projects \|GSoC 2010 Ideas page]] \| [[GSOC2010AcceptedProjects \|GSoC 2010 Accepted Projects]]

Lalith at 18:55, 29 March 2011

2011-03-29T18:55:59Z

← Older revision		Revision as of 18:55, 29 March 2011
Line 56:		Line 56:
	== Where to begin ==		== Where to begin ==

	A good starting point would be to read the [GSOC2011Projects \|NSoC 2011 Ideas page]]. After you decide which idea you would like to work on, join the [http://mailman.isi.edu/mailman/listinfo/ns-developers development mailing list] and enter #ns-3 on freenode.net IRC chat to discuss your ideas with us.		A good starting point would be to read the [[GSOC2011Projects \|NSoC 2011 Ideas page]]. After you decide which idea you would like to work on, join the [http://mailman.isi.edu/mailman/listinfo/ns-developers development mailing list] and enter #ns-3 on freenode.net IRC chat to discuss your ideas with us.

	== How to apply ==		== How to apply ==

Lalith at 18:55, 29 March 2011

2011-03-29T18:55:23Z

← Older revision		Revision as of 18:55, 29 March 2011
Line 3:		Line 3:
	<blockquote style="padding: 2em ">		<blockquote style="padding: 2em ">

	* [http://socghop.appspot.com/document/show/gsoc_program/google/gsoc2010/faqs GSoC Frequently Asked Questions]
	* [http://en.flossmanuals.net/GSoCMentoringGuide GSoC Mentors Guide]
	* [http://www.booki.cc/gsocstudentguide/_v/1.0/what-is-google-summer-of-code/ Official GSoC Student Guide]
	* [[GS02011StudentGuide \|ns-3 GSoC/NSoC Student guide]]		* [[GS02011StudentGuide \|ns-3 GSoC/NSoC Student guide]]
	* [[GS02011StudentApplicationTemplate \|NSoC Student application template]]		* [[GS02011StudentApplicationTemplate \|NSoC Student application template]]

Lalith at 18:55, 29 March 2011

2011-03-29T18:55:03Z

Lalith at 18:51, 29 March 2011

2011-03-29T18:51:28Z

← Older revision		Revision as of 18:51, 29 March 2011
Line 6:		Line 6:
	* [http://en.flossmanuals.net/GSoCMentoringGuide GSoC Mentors Guide]		* [http://en.flossmanuals.net/GSoCMentoringGuide GSoC Mentors Guide]
	* [http://www.booki.cc/gsocstudentguide/_v/1.0/what-is-google-summer-of-code/ Official GSoC Student Guide]		* [http://www.booki.cc/gsocstudentguide/_v/1.0/what-is-google-summer-of-code/ Official GSoC Student Guide]
	* [[GS02011StudentGuide \|ns-3 GSoC Student guide]]		* [[GS02011StudentGuide \|ns-3 GSoC/NSoC Student guide]]
	* [[GS02011StudentApplicationTemplate \|~~GSoC~~ Student application template]]		* [[GS02011StudentApplicationTemplate \|NSoC Student application template]]
	* [[GSOC2011Projects \|~~GSoC~~ 2011 Ideas page]]		* [[GSOC2011Projects \|NSoC 2011 Ideas page]]
	* [[GSOC2010Projects \|GSoC 2010 Ideas page]] \| [[GSOC2010AcceptedProjects \|GSoC 2010 Accepted Projects]]		* [[GSOC2010Projects \|GSoC 2010 Ideas page]] \| [[GSOC2010AcceptedProjects \|GSoC 2010 Accepted Projects]]
	* [[GSOC2009Projects \|GSoC 2009 Ideas page]] \| [[GSOC2009AcceptedProjects \|GSoC 2009 Accepted Projects]]		* [[GSOC2009Projects \|GSoC 2009 Ideas page]] \| [[GSOC2009AcceptedProjects \|GSoC 2009 Accepted Projects]]

Lalith at 12:56, 27 February 2011

2011-02-27T12:56:14Z

← Older revision		Revision as of 12:56, 27 February 2011
Line 5:		Line 5:
	* [http://socghop.appspot.com/document/show/gsoc_program/google/gsoc2010/faqs GSoC Frequently Asked Questions]		* [http://socghop.appspot.com/document/show/gsoc_program/google/gsoc2010/faqs GSoC Frequently Asked Questions]
	* [http://en.flossmanuals.net/GSoCMentoringGuide GSoC Mentors Guide]		* [http://en.flossmanuals.net/GSoCMentoringGuide GSoC Mentors Guide]
	* [[GS02011StudentGuide \|GSoC Student guide]]		* [http://www.booki.cc/gsocstudentguide/_v/1.0/what-is-google-summer-of-code/ Official GSoC Student Guide]
			* [[GS02011StudentGuide \|ns-3 GSoC Student guide]]
	* [[GS02011StudentApplicationTemplate \|GSoC Student application template]]		* [[GS02011StudentApplicationTemplate \|GSoC Student application template]]
	* [[GSOC2011Projects \|GSoC 2011 Ideas page]]		* [[GSOC2011Projects \|GSoC 2011 Ideas page]]

← Older revision		Revision as of 17:45, 10 April 2011
Line 9:		Line 9:
	* [[GSOC2009Projects \|GSoC 2009 Ideas page]] \| [[GSOC2009AcceptedProjects \|GSoC 2009 Accepted Projects]]		* [[GSOC2009Projects \|GSoC 2009 Ideas page]] \| [[GSOC2009AcceptedProjects \|GSoC 2009 Accepted Projects]]
	* [[GSOC2010OAReport \|GSoC Organization Administrator guide]]		* [[GSOC2010OAReport \|GSoC Organization Administrator guide]]
			<!--
	* [[Media:ns3GSOC2011Flyer.jpg \| ns3's GSoC 2011 Flyer]]		* [[Media:ns3GSOC2011Flyer.jpg \| ns3's GSoC 2011 Flyer]]
			-->
	* ''Get in contact with the ns-3 team'': [http://mailman.isi.edu/mailman/listinfo/ns-developers ns-developers mailing list] \| ''IRC'' #ns-3 on freenode.net		* ''Get in contact with the ns-3 team'': [http://mailman.isi.edu/mailman/listinfo/ns-developers ns-developers mailing list] \| ''IRC'' #ns-3 on freenode.net

← Older revision		Revision as of 18:59, 29 March 2011
Line 4:		Line 4:

	* [[GS02011StudentGuide \|ns-3 GSoC/NSoC Student guide]]		* [[GS02011StudentGuide \|ns-3 GSoC/NSoC Student guide]]
	* [[~~NS02011StudentApplicationTemplate~~ \|NSoC Student application template]]		* [[GS02011StudentApplicationTemplate \|NSoC Student application template]]
	* [[GSOC2011Projects \|NSoC 2011 Ideas page]]		* [[GSOC2011Projects \|NSoC 2011 Ideas page]]
	* [[GSOC2010Projects \|GSoC 2010 Ideas page]] \| [[GSOC2010AcceptedProjects \|GSoC 2010 Accepted Projects]]		* [[GSOC2010Projects \|GSoC 2010 Ideas page]] \| [[GSOC2010AcceptedProjects \|GSoC 2010 Accepted Projects]]

← Older revision		Revision as of 18:58, 29 March 2011
Line 4:		Line 4:

	* [[GS02011StudentGuide \|ns-3 GSoC/NSoC Student guide]]		* [[GS02011StudentGuide \|ns-3 GSoC/NSoC Student guide]]
	* [[~~GS02011StudentApplicationTemplate~~ \|NSoC Student application template]]		* [[NS02011StudentApplicationTemplate \|NSoC Student application template]]
	* [[GSOC2011Projects \|NSoC 2011 Ideas page]]		* [[GSOC2011Projects \|NSoC 2011 Ideas page]]
	* [[GSOC2010Projects \|GSoC 2010 Ideas page]] \| [[GSOC2010AcceptedProjects \|GSoC 2010 Accepted Projects]]		* [[GSOC2010Projects \|GSoC 2010 Ideas page]] \| [[GSOC2010AcceptedProjects \|GSoC 2010 Accepted Projects]]

← Older revision		Revision as of 18:51, 29 March 2011
Line 6:		Line 6:
	* [http://en.flossmanuals.net/GSoCMentoringGuide GSoC Mentors Guide]		* [http://en.flossmanuals.net/GSoCMentoringGuide GSoC Mentors Guide]
	* [http://www.booki.cc/gsocstudentguide/_v/1.0/what-is-google-summer-of-code/ Official GSoC Student Guide]		* [http://www.booki.cc/gsocstudentguide/_v/1.0/what-is-google-summer-of-code/ Official GSoC Student Guide]
	* [[GS02011StudentGuide \|ns-3 GSoC Student guide]]		* [[GS02011StudentGuide \|ns-3 GSoC/NSoC Student guide]]
	* [[GS02011StudentApplicationTemplate \|~~GSoC~~ Student application template]]		* [[GS02011StudentApplicationTemplate \|NSoC Student application template]]
	* [[GSOC2011Projects \|~~GSoC~~ 2011 Ideas page]]		* [[GSOC2011Projects \|NSoC 2011 Ideas page]]
	* [[GSOC2010Projects \|GSoC 2010 Ideas page]] \| [[GSOC2010AcceptedProjects \|GSoC 2010 Accepted Projects]]		* [[GSOC2010Projects \|GSoC 2010 Ideas page]] \| [[GSOC2010AcceptedProjects \|GSoC 2010 Accepted Projects]]
	* [[GSOC2009Projects \|GSoC 2009 Ideas page]] \| [[GSOC2009AcceptedProjects \|GSoC 2009 Accepted Projects]]		* [[GSOC2009Projects \|GSoC 2009 Ideas page]] \| [[GSOC2009AcceptedProjects \|GSoC 2009 Accepted Projects]]

← Older revision		Revision as of 18:55, 29 March 2011
Line 19:		Line 19:
	= Student Guidelines =		= Student Guidelines =

	This webpage highlights the expectations and requirements for student applicants for ns-3's ~~[http://code.google.com/soc Google~~ Summer of Code] 2011 effort.<br/>		This webpage highlights the expectations and requirements for student applicants for ns-3's Summer of Code 2011 effort.<br/>

	== Project Expectations ==		== Project Expectations ==

	The ns-3 team is looking for three things from every successful ~~GSoC~~ project:		The ns-3 team is looking for three things from every successful NSoC project:
	* Developing code that can be incorporated back into the main codebase and utilized by a variety of users.		* Developing code that can be incorporated back into the main codebase and utilized by a variety of users.
	* Developing new members that will remain part of the team and contribute to the ns-3 effort even after ~~GSoC~~ ends.		* Developing new members that will remain part of the team and contribute to the ns-3 effort even after NSoC ends.
	* Providing ~~GSoC~~ students with experience and ideas that will be useful to them in their careers and/or research.		* Providing NSoC students with experience and ideas that will be useful to them in their careers and/or research.

	== Student Expectations ==		== Student Expectations ==

	* The student will be expected to commit fully to the project, the time effort required from the student will the same as a full time job. Applicants should recognize that being accepted into ~~GSoC~~ is a serious commitment and will be the focus of their time over the duration of the program. Any existing commitments for class, other jobs, etc should be discussed as part of your application.		* The student will be expected to commit fully to the project, the time effort required from the student will the same as a full time job. Applicants should recognize that being accepted into NSoC is a serious commitment and will be the focus of their time over the duration of the program. Any existing commitments for class, other jobs, etc should be discussed as part of your application.
	* At the beginning of the program, the student will be required to provide a detailed plan of work covering the 12 weeks of ~~GSoC~~. This should be developed with the help of the mentor. Students will have to setup a wiki page for their project, and cover important aspects of their proposal's design, the strategy to implement it, a list of deliverables, and lastly, update the wiki page as and when each milestone is achieved. This page along with the code repository allows the community to keep track of the student's efforts.		* At the beginning of the program, the student will be required to provide a detailed plan of work covering the 12 weeks of NSoC. This should be developed with the help of the mentor. Students will have to setup a wiki page for their project, and cover important aspects of their proposal's design, the strategy to implement it, a list of deliverables, and lastly, update the wiki page as and when each milestone is achieved. This page along with the code repository allows the community to keep track of the student's efforts.
	* The student will be expected to produce mergeable code (either merged completely at the end of the project, partially at the end of the project, or not merged yet but no major roadblocks foreseen to merge shortly after the program ends).		* The student will be expected to produce mergeable code (either merged completely at the end of the project, partially at the end of the project, or not merged yet but no major roadblocks foreseen to merge shortly after the program ends).
	* The student will be expected to follow ns-3 design guidelines (follow coding style, write tests, documentation).		* The student will be expected to follow ns-3 design guidelines (follow coding style, write tests, documentation).
	* Students are required to submit weekly reports on the mailing list, covering the progress they've made or the obstacles they've run into. This will help the community keep track of the student's efforts, and help as needed.		* Students are required to submit weekly reports on the mailing list, covering the progress they've made or the obstacles they've run into. This will help the community keep track of the student's efforts, and help as needed.
	* The student will have his or her code reviewed twice by the ns-3 community. The first review will be taken prior to the mid-term evaluations and will look at issues such as scope, public API, test plan, and open issues. The second review will be taken at least two weeks prior to the end of the program and will include review of the produced code for possible merge into the project main tree. All students will be briefed on a checklist of things to prepare for these reviews. Between these reviews, mentors will periodically (at least weekly) review the student's output and will provide guidance where needed, and track this progress in a public place such as a wiki entry or the mailing list.		* The student will have his or her code reviewed twice by the ns-3 community. The first review will be taken prior to the mid-term evaluations and will look at issues such as scope, public API, test plan, and open issues. The second review will be taken at least two weeks prior to the end of the program and will include review of the produced code for possible merge into the project main tree. All students will be briefed on a checklist of things to prepare for these reviews. Between these reviews, mentors will periodically (at least weekly) review the student's output and will provide guidance where needed, and track this progress in a public place such as a wiki entry or the mailing list.
	* If a student drops the project before the ~~GSoC~~ program ends, he/she will be failed.		* If a student drops the project before the NSoC program ends, he/she will be failed.

	Students have inquired about what software development background and tools are required. ns-3 development typically requires proficiency in C++ and a debugger such as gdb or ddd. The valgrind suite of tools, and a system profiler such as oprofile, are typically useful. Python may be necessary for some projects dealing with the build system or that involve using Python to integrate ns-3 with other programs, but is generally an optional component.		Students have inquired about what software development background and tools are required. ns-3 development typically requires proficiency in C++ and a debugger such as gdb or ddd. The valgrind suite of tools, and a system profiler such as oprofile, are typically useful. Python may be necessary for some projects dealing with the build system or that involve using Python to integrate ns-3 with other programs, but is generally an optional component.
Line 42:		Line 42:
	== The Selection Process ==		== The Selection Process ==

	Selection of students for ~~GSoC is~~ competitive; last year, this project saw a 12.5% acceptance ratio.		Selection of students for NSoC will be competitive; last year, for GSoC, this project saw a 12.5% acceptance ratio.
	The students will be selected by a selection committee which will consist of the candidate mentors and selected active maintainers. Students projects will be evaluated and scored according to the following criteria: <br/>		The students will be selected by a selection committee which will consist of the candidate mentors and selected active maintainers. Students projects will be evaluated and scored according to the following criteria: <br/>
	*1) Overall technical quality of application, including whether the project seems feasible and properly scoped, whether the student appears knowledgeable about ns-3, C++, the models that are being proposed, and the project plan including proposed milestones.		*1) Overall technical quality of application, including whether the project seems feasible and properly scoped, whether the student appears knowledgeable about ns-3, C++, the models that are being proposed, and the project plan including proposed milestones.
Line 48:		Line 48:
	*3) Impact and relevance to future users of ns-3? (e.g. does proposed project support an active field of research? Are results of the project broadly applicable? Does it bring unique capabilities to ns-3?)		*3) Impact and relevance to future users of ns-3? (e.g. does proposed project support an active field of research? Are results of the project broadly applicable? Does it bring unique capabilities to ns-3?)
	*4) Participation and involvement in the community and with prospective mentors.		*4) Participation and involvement in the community and with prospective mentors.
	~~and any other criteria that the GSOC program suggests to us.~~

	High scoring applicants may be asked to discuss their project details over email or IRC. When the evaluation process concludes, the organization administrator will determine the highest ranking applicants and if there are close rankings or concerns, hold a meeting among selection committee members to resolve tiebreakers.		High scoring applicants may be asked to discuss their project details over email or IRC. When the evaluation process concludes, the organization administrator will determine the highest ranking applicants and if there are close rankings or concerns, hold a meeting among selection committee members to resolve tiebreakers.
Line 60:		Line 59:
	== Where to begin ==		== Where to begin ==

	A good starting point would be to read the ~~[http://socghop.appspot.com/document/show/gsoc_program/google/gsoc2011/faqs GSoC Frequently Asked Questions], then read the [~~[GSOC2011Projects \|~~GSoC~~ 2011 Ideas page]]. After you decide which idea you would like to work on, join the [http://mailman.isi.edu/mailman/listinfo/ns-developers development mailing list] and enter #ns-3 on freenode.net IRC chat to discuss your ideas with us.		A good starting point would be to read the [GSOC2011Projects \|NSoC 2011 Ideas page]]. After you decide which idea you would like to work on, join the [http://mailman.isi.edu/mailman/listinfo/ns-developers development mailing list] and enter #ns-3 on freenode.net IRC chat to discuss your ideas with us.

	== How to apply ==		== How to apply ==

	For information on how to apply go to [http://socghop.appspot.com/document/show/gsoc_program/google/gsoc2011/faqs#student_apply how to apply to GSoC]. The application window for students begins on March 28th 19:00 UTC and the deadline for the same is April 8 at 19:00 UTC.		Information regarding this will be up soon.

	While students are encouraged to discuss their technical plans with potential mentors on the ns-developers list ~~(see [http://www.nsnam.org/wiki/index.php?title=GS02011StudentGuide#A_piece_of_advice A piece of advice] below)~~, they are under no obligation to share their application details on the list.		While students are encouraged to discuss their technical plans with potential mentors on the ns-developers list, they are under no obligation to share their application details on the list.

	== Student benefits ==		== Student benefits ==

	* ~~GSoC~~ is an excellent opportunity to gain experience working on an open source project.		* NSoC is an excellent opportunity to gain experience working on an open source project.
	* Working with the ns-3 project will allow you to improve your networking knowledge, C++ skills and to be in contact with a highly skilled team of developers and user group.		* Working with the ns-3 project will allow you to improve your networking knowledge, C++ skills and to be in contact with a highly skilled team of developers and user group.
	* This is a great opportunity to contribute to our open source community.		* This is a great opportunity to contribute to our open source community.
Line 82:		Line 81:
	Additional slides about the ns-3 GSoC project (from last year) are also available, from a [http://www.nsnam.org/docs/gsoc.ppt GSoC Infosession] at the University of Washington on March 5th, 2009.		Additional slides about the ns-3 GSoC project (from last year) are also available, from a [http://www.nsnam.org/docs/gsoc.ppt GSoC Infosession] at the University of Washington on March 5th, 2009.

	[[Category:~~GSoC~~]]		[[Category:NSoC]]