Clone wiki

yt / Google Summer of Code 2016 Guidelines

About

yt is a community-developed toolkit for visualization and analysis of volumetric data. It is able to read data produced by many astrophysics simulation codes, radio telescopes, and nuclear engineering simulations. The yt project is participating in the Google Summer of Code 2016 under the OpenAstronomy umbrella organization. Please also read the student guidelines page to get started. Additional useful information can be found in the Python organization GSoC guide.

Note that the deadline for applying is March 25th 2016, and you should get in touch with the yt developers as soon as possible, since preparing your application and patch will likely require communicating with the developers over a couple of weeks!

Applying

If you are interested in participating, follow these steps:

  1. Read over the GSoC 2016 site to understand better how the program works and whether you are eligible to participate.

  2. Take a look at the yt ideas list and pick a project that matches your skills and interest. You will increase your chances of being selected if you familiarize yourself with the project idea and show a good understanding of it when you contact the yt developers. What matters is not how hard the project is, but how well matched you are to the project.

  3. Join our mailing list, yt-dev, introduce yourself, and let us know of your interest, so that we can pair you up with two prospective mentors to help you prepare your application.

  4. Take a look at the open yt issues, pick an issue that is not being worked on. Leave a comment that you will be attempting to solve the issue, and attempt to solve the issue. You will need to build yt from source, set up a development environment, and debug the issue. Once you have a fix, open a pull request on bitbucket.

  5. Create a blog so your mentors and others in the project can keep track of your progress.

  6. Start working on your application. If you would like us to give feedback on your application, please create a new page on this wiki with the name GSoC 2016 Application <Your Name>:<Project Name> and link to this page from the GSoC 2016 Applications page. Please follow the Python organization template. This student guide and Sympy Application Template also provides some additional advice on preparing your application.

  7. Submit your application via the Google Summer of Code site! Let your potential mentors know once you have done this so they can give it a final look over.

Recommendations

  1. Take the initiative - we can send you information on the projects and feedback on the applications, but it is your responsibility to ask the questions and start preparing your application. We will let you know if something is missing from your application or if any of the goals are unrealistic, but we will not write the application.

  2. Use yt - you will gain a much better understanding of how yt works by actually using it. Download it, install it, and follow some of the examples in the documentation, to get a better idea of what it can do.

  3. Familiarize yourself with the development guidelines for yt. The developer guide contains a lot of information on how to contribut to yt using mercurial and bitbucket, how to navigate the codebase, how to write tests, documentation, etc. The more understanding of the workflow you can demonstrate, the better your chances.

Good luck! :)

Updated