Summer of Code - Getting Started: Difference between revisions

Jump to navigation Jump to search
(→‎Suggested projects: Add Table datatype.)
(→‎Steps toward a successful application: rearranging and rewording)
(10 intermediate revisions by one other user not shown)
Line 1: Line 1:
Since 2011 the GNU Octave project has mentored 38 students in [[Summer of Code]] (SoC) programs by [https://summerofcode.withgoogle.com/ Google] and [https://socis.esa.int/ ESA].  Those programs aim to populate open-source software development and to attract potential new Octave developers.
{{Note|GNU Octave [https://summerofcode.withgoogle.com/organizations/5849336744771584/ has been selected] as mentoring organization for GSoC 2021.}}
 
Since 2011 the GNU Octave project has mentored 38 students in [[Summer of Code]] (SoC) programs by [https://summerofcode.withgoogle.com/ Google] and [https://socis.esa.int/ ESA].  Those programs aim to advertise open-source software development and to attract potential new Octave developers.


= Steps toward a successful application =
= Steps toward a successful application =


# 😉💬 '''We want to get to know you.  Communicate with us.'''
# 😉💬 '''We want to get to know you (before the deadline).  Communicate with us.'''
#* Join [https://octave.discourse.group/ '''Octave Discourse'''] or our [https://webchat.freenode.net/?channels=#octave '''IRC channel'''].
#* Join [https://octave.discourse.group/ '''Octave Discourse'''] or our [https://webchat.freenode.net/?channels=#octave '''IRC channel''']. Using a nickname is fine.
#* We are interested in you as motivated developer 💻  There is no need to present an overwhelming CV with prestigious universities 🏰 and programming contest awards 🏆 in it.  We are very fine if you just communicate using a nickname with us.  
#* Show us that you're motivated to work on Octave 💻. There is no need to present an overwhelming CV 🏆; evidence of involvement with Octave is more important.
#* If your first question is "Hi I'm new to Octave. What should I do?" '''you are out''' 🤦
#* '''<span style="color:darkblue;">If you never talked to us, we will likely reject your proposal</span>''', even it looks good 🚮
#* Remember, '''we are mentors and not your boss 🙂'''
# 📝💡 '''Tell us what you are going to do.'''
#* When you contact us for the first time, do not write just to say in what project you're interested in.  Be specific about what you are going to do, post many links 🔗, show us you know what you are talking about 💡, and ask many [http://www.catb.org/esr/faqs/smart-questions.html smart questions] 🤓
# 👩‍🔬 '''Get your hands dirty.'''
# 👩‍🔬 '''Get your hands dirty.'''
#* We are curious about your programming skills ⌨️
#* We are curious about your programming skills 🚀
#** Try to [https://savannah.gnu.org/bugs/?group=octave fix Octave bugs] or [https://savannah.gnu.org/patch/?group=octave submit patches] '''before''' the end of the application deadline.
#** Your application will be much stronger if you [https://savannah.gnu.org/bugs/?group=octave fix Octave bugs] or [https://savannah.gnu.org/patch/?group=octave submit patches] before or during the application period.
#** Take a look at the [[Short projects]] for simple bugs to start with.
#** You can take a look at the [[short projects]] for some simple bugs to start with.
#* '''Use Octave!'''
#* '''Use Octave!'''
#** If you come across something that does not work the way you like ➡️ try to fix that 🔧
#** If you come across something that does not work the way you like ➡️ try to fix that 🔧
#** Or you come across a missing function ➡️ try to implement it.
#** Or if you find a missing function ➡️ try to implement it.
# 📝💡 '''Tell us what you are going to do.'''
#* Do not write just to say what project you're interested in.  Be specific about what you are going to do, include links 🔗, show us you know what you are talking about 💡, and ask many [http://www.catb.org/esr/faqs/smart-questions.html smart questions] 🤓
#* Remember, '''we are volunteer developers and not your boss''' 🙂
# 📔 '''Prepare your proposal with us.'''
# 📔 '''Prepare your proposal with us.'''
#* GSoC, for example, [https://google.github.io/gsocguides/student/writing-a-proposal requires to submit a proposal].
#* If we see your proposal for the first time after the application deadline, it might easily contain some paragraphs not fully clear to us.  Ongoing interaction will give us more confidence that you are capable of working on your project 😓
#* If we see your proposal for the first time after the application deadline, you can easily imagine that it might contain ambiguities or some paragraphs are not fully clear to us.  We easily get doubts if you are capable of working on your project 😓
#* Try to show us as early as possible a draft of your proposal 👍
#* Try to show us as early as possible a draft of your proposal 👍
#* Then submit the proposal following the applicable rules, e.g. for [https://google.github.io/gsocguides/student/writing-a-proposal GSoC].


= How do we judge your application? =
= How do we judge your application? =
Line 104: Line 106:
== Table datatype ==
== Table datatype ==


In 2013, Matlab introduced a [https://www.mathworks.com/help/matlab/ref/table.html new table datatype] to conveniently organize and access data in tabular form.  This datatype has not been introduced to Octave yet (see bug {{bug|44571}}).  However, there are two initial implementation approaches https://github.com/apjanke/octave-tablicious and https://github.com/gnu-octave/table.
In 2013, Matlab introduced a [https://www.mathworks.com/help/matlab/tables.html new table datatype] to conveniently organize and access data in tabular form.  This datatype has not been introduced to Octave yet (see bug {{bug|44571}}).  However, there are two initial implementation approaches https://github.com/apjanke/octave-tablicious and https://github.com/gnu-octave/table.
 
Based upon the existing approaches, the goal of this project is to define an initial subset of [https://www.mathworks.com/help/matlab/tables.htmlMatlab's table functions], which involve sorting, splitting, merging, and file I/O and implement it within the given time frame.
 
* '''Required skills'''
: Knowledge of Octave, C/C++
* '''Potential mentors'''
: [[User:siko1056|Kai]]
 
== Jupyter Notebook Integration ==
 
<q>The [https://jupyter.org Jupyter Notebook] is an open-source web application that allows you to create and share documents that contain live code, equations, visualizations and narrative text.</q>
 
To interactively work with Octave code within Jupyter Notebooks, there already exists an [https://github.com/Calysto/octave_kernel Octave kernel for Jupyter].
 
'''This project''' aims to support the '''opposite direction''': running (and filling) Jupyter Notebook within GNU Octave.  This would enable Jupyter Notebook users to evaluate '''long running Octave Notebooks''' on a computing server without permanent browser connection, which is [https://github.com/jupyter/notebook/issues/1647 still a pending issue].  To achieve this, different strategies are possible:
 
# Synchronize an internal Octave data structure (e.g. classdef object) with the Jupyter Notebook.  Probably the safest approach, but does not enable any interactivity from the Octave GUI.
# Import/export a Jupyter Notebook as Octave script (translate non-code sections to comments and vice versa).  Files can be edited from the Octave GUI, but probably conversion losses might occur (e.g. embedded graphics).
# A synthesis of both approaches?
 
In general a [https://nbformat.readthedocs.io/en/latest/ Jupyter Notebook] is a plain JSON document, which will be supported in Octave 7 (current development version) or through the [https://gnu-octave.github.io/pkg-index/package/pkg-json JSON package] for older Octave versions.


* '''Required skills'''
* '''Required skills'''
281

edits

Navigation menu