281
edits
Summer of Code - Getting Started: Difference between revisions
Jump to navigation
Jump to search
update for 2024
(update for 2024) |
|||
| (21 intermediate revisions by 6 users not shown) | |||
| Line 1: | Line 1: | ||
{{Note|GNU Octave is a [https://summerofcode.withgoogle.com/programs/ | {{Note|GNU Octave is a [https://summerofcode.withgoogle.com/programs/2024/organizations/gnu-octave mentoring organization for GSoC 2024].}} | ||
Since 2011 the GNU Octave project has successfully mentored: | Since 2011 the GNU Octave project has successfully mentored: | ||
* [[Summer of Code | ''' | * [[Summer of Code | '''42 participants''' 🙂]] | ||
* [[Summer of Code | ''' | * [[Summer of Code | '''44 projects''' 📝]] | ||
in [[Summer of Code]] (SoC) programs by [https://summerofcode.withgoogle.com/ Google] and [https://esa.int/ ESA]. | in [[Summer of Code]] (SoC) programs by [https://summerofcode.withgoogle.com/ Google] and [https://esa.int/ ESA]. | ||
| Line 11: | Line 11: | ||
# 😉💬 '''We want to get to know you (before the deadline). Communicate with us.''' | # 😉💬 '''We want to get to know you (before the deadline). Communicate with us.''' | ||
#* Join [https://octave.discourse.group/ '''Octave Discourse'''] or [[IRC]]. Using a nickname is fine. | #* Join [https://octave.discourse.group/ '''Octave Discourse'''] or [[IRC]] for general discussion and to ask questions (Please do not use the bug tracker for general GSOC inquiries unrelated to specific bugs found with Octave.) Using a nickname is fine. | ||
#* 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. | #* 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. | ||
#* '''<span style="color:darkblue;">If you never talked to us, we will likely reject your proposal</span>''', even it looks good 🚮 | #* '''<span style="color:darkblue;">If you never talked to us, we will likely reject your proposal</span>''', even it looks good 🚮 | ||
| Line 56: | Line 56: | ||
= Suggested projects = | = Suggested projects = | ||
The following suggested projects are distilled from the [[Projects]] page for the benefit of potential SoC participants. You can also look at our [[Summer of Code|completed past projects]] for more inspiration. | The following suggested projects are distilled from the [[Projects]] page for the benefit of potential SoC participants. You can also look at our [[Summer of Code|completed past projects]], or the current [https://hg.savannah.gnu.org/hgweb/octave/file/tip/etc/ROADMAP.md | Octave Development Roadmap] for more inspiration. | ||
{{Note|Do you use Octave at your working place or university? Do you have some numerical project in mind? You are always welcome to '''propose your own projects'''. If you are passionate about your project, it will be easy to find an Octave developer to mentor and guide you.}} | {{Note|Do you use Octave at your working place or university? Do you have some numerical project in mind? You are always welcome to '''propose your own projects'''. If you are passionate about your project, it will be easy to find an Octave developer to mentor and guide you. Please note that for such a proposal to be successful it will almost certainly involve initiating pre-proposal discussion over at the [https://octave.discourse.group Octave Discourse forum].}} | ||
== Adding more Classification classes and implementing missing methods in statistics package == | |||
Although a ClassificationKNN class was added in the latest statistics release (1.6.1), it still lacks several methods (only `predict` is available at the moment). This GSoC project aims at implementing more methods, such as crossval, cvloss, lime, loss, margin, partialDependence, plotPartialDependence, etc., as well as adding more classdefs related to classification classes, such as ClassificationGAM, ClassificationDiscriminant, ClassificationSVM, ClassificationNeuralNetwork, ClassificationNaiveBayes, etc. The statistics package, although heavily developed during the past years, still lacks a lot of classdef functionality. The scope is to implement classification classdef objects and their relevant methods in a MATLAB-compatible way. | |||
* '''Project size''' [[#Project sizes | [?]]] and '''Difficulty''' | |||
: ~350 hours (hard) | |||
* '''Required skills''' | |||
: Octave, classdef, good knowledge of statistical methods | |||
* '''Potential mentors''' | |||
: [https://octave.discourse.group/u/pr0m1th3as Andreas Bertsatos] | |||
== Custom re-implementation of the texi2html (v.1.82) command line tool == | |||
Implement a compiled .oct function to relax the dependency of the pkg-octave-doc package on texi2html (v.1.82) command line tool, which is no longer maintained or further developed but also not readily available to all linux distributions. The idea is to have a `texi2html` function within the pkg-octave-doc package that will replace the functionality of the texi2html (v.1.82) command line tool. This will also help improve the speed of pkg-octave-doc processing large packages, which contain specific tags (such as @math) which are currently handled within Octave code. | |||
* '''Project size''' [[#Project sizes | [?]]] and '''Difficulty''' | |||
: ~350 hours (hard) | |||
* '''Required skills''' | |||
: Perl, C++, Octave, Texinfo, HTML | |||
* '''Potential mentors''' | |||
: [https://octave.discourse.group/u/pr0m1th3as Andreas Bertsatos] | |||
== Port Chebfun to Octave and improve classdef support == | |||
[https://www.chebfun.org| Chebfun] uses interpolation to approximate functions to very high accuracy, giving numerical computing that feels like symbolic computing. | |||
The software is implemented as collection of "classdef" classes and is Free and Open Source Software. | |||
However, Chebfun does not yet work with Octave, largely due to differences and issues with Octave's classdef implementation. | |||
This project has two aims: (1) make changes to the Chebfun code to make it work on Octave and (2) improve Octave's classdef functionality. | |||
Some initial steps toward to first goal can be found on [https://github.com/cbm755/chebfun/tree/octave_dev| this octave_dev branch]. | |||
The second goal will likely involve a collaborative effort because classdef is a priority on [https://hg.savannah.gnu.org/hgweb/octave/file/tip/etc/ROADMAP.md | Octave's Development Roadmap] and because other proposed projects also involve classdef. | |||
* '''Project size''' [[#Project sizes | [?]]] and '''Difficulty''' | |||
: ~350 hours (hard) | |||
* '''Required skills''' | |||
: Octave, object-oriented programming, polynomial interpolation and approximation theory, C++. | |||
* '''Potential mentors''' | |||
: [https://octave.discourse.group/u/cbm Colin B. Macdonald] | |||
<!-- | |||
== ode15{i,s} : Matlab Compatible DAE solvers == | == ode15{i,s} : Matlab Compatible DAE solvers == | ||
| Line 73: | Line 114: | ||
* '''Potential mentors''' | * '''Potential mentors''' | ||
: Francesco Faccio, [https://octave.discourse.group/u/cdf Carlo de Falco], [https://octave.discourse.group/u/marco_caliari Marco Caliari], Jacopo Corno, [https://octave.discourse.group/u/schoeps Sebastian Schöps] | : Francesco Faccio, [https://octave.discourse.group/u/cdf Carlo de Falco], [https://octave.discourse.group/u/marco_caliari Marco Caliari], Jacopo Corno, [https://octave.discourse.group/u/schoeps Sebastian Schöps] | ||
--> | |||
<!-- | |||
== PolarAxes and Plotting Improvements == | == PolarAxes and Plotting Improvements == | ||
Octave currently provides | Octave currently provides support for polar axes by using a Cartesian 2-D axes and adding a significant number of properties and callback listeners to get things to work. What is needed is the implementation of a dedicated "polaraxes" object in C++. This will require creating a new fundamental graphics object type, and programming in C++/OpenGL to render the object. When "polaraxes" exists as an object type, then m-files will be written to access them, including polaraxes.m, polarplot.m, rticks.m, rticklabels.m, thetaticks, thetaticklabels.m, rlim.m, thetalim.m. This relates to bug {{bug|49804}}. | ||
* '''Project size''' [[#Project sizes | [?]]] and '''Difficulty''' | * '''Project size''' [[#Project sizes | [?]]] and '''Difficulty''' | ||
| Line 94: | Line 127: | ||
* '''Potential mentors''' | * '''Potential mentors''' | ||
: [https://octave.discourse.group/u/rik Rik] | : [https://octave.discourse.group/u/rik Rik] | ||
--> | |||
<!-- | |||
== Table datatype == | == Table datatype == | ||
| Line 105: | Line 140: | ||
* '''Required skills''' | * '''Required skills''' | ||
: Octave, C/C++ | : Octave, C/C++ | ||
* '''Potential mentors''' | |||
: ??? | |||
--> | |||
<!-- | |||
== TISEAN package == | == TISEAN package == | ||
| Line 116: | Line 155: | ||
* '''Potential mentors''' | * '''Potential mentors''' | ||
: [https://octave.discourse.group/u/kakila KaKiLa] | : [https://octave.discourse.group/u/kakila KaKiLa] | ||
--> | |||
<!-- | |||
== Better tab completion == | == Better tab completion == | ||
| Line 143: | Line 184: | ||
To get more examples, see how bash completion works. You can type git or hg and then tab and it will give the list of available commands. If you type "sort --r" and then tab, it gives the list of options to sort starting with "--r", etc. | To get more examples, see how bash completion works. You can type git or hg and then tab and it will give the list of available commands. If you type "sort --r" and then tab, it gives the list of options to sort starting with "--r", etc. | ||
* '''Project size''' [[#Project sizes | [?]]] and '''Difficulty''' | |||
: ~350 hours (medium) | |||
* '''Required skills''' | |||
: ??? | |||
* '''Potential mentors''' | |||
: ??? | |||
--> | |||
<!-- | |||
== Graphics rendering back to front sorting == | == Graphics rendering back to front sorting == | ||
Several incompatibilities have been identified in how Octave plots transparent objects in 3D, causing certain transparent objects to hide opaque objects behind them even though they're not supposed to. The vast majority of them were isolated to one problem: if the objects to be drawn are rendered such that the one farthest away from the viewer is rendered first and nearer objects are rendered on top of that, then transparency would be automatically achieved, but this needs very careful coding to stay performant and to avoid rendering objects that will be overwritten fully by others. See [https://savannah.gnu.org/bugs/?57980] for a summary. | Several incompatibilities have been identified in how Octave plots transparent objects in 3D, causing certain transparent objects to hide opaque objects behind them even though they're not supposed to. The vast majority of them were isolated to one problem: if the objects to be drawn are rendered such that the one farthest away from the viewer is rendered first and nearer objects are rendered on top of that, then transparency would be automatically achieved, but this needs very careful coding to stay performant and to avoid rendering objects that will be overwritten fully by others. See [https://savannah.gnu.org/bugs/?57980] for a summary. | ||
* '''Project size''' [[#Project sizes | [?]]] and '''Difficulty''' | |||
: ~350 hours (medium) | |||
* '''Required skills''' | |||
: ??? | |||
* '''Potential mentors''' | |||
: ??? | |||
--> | |||
<!-- | |||
== Symbolic package == | |||
The [[Symbolic package]] provides symbolic computing and other [https://en.wikipedia.org/wiki/Computer_algebra_system computer algebra system] tools via the [https://sympy.org SymPy Python library]. GSoC projects in 2016 and 2022 improved the package. | |||
There are no specific plans for Symbolic in GSoC 2023, but improvements elsewhere that would help Symbolic include: | |||
* Developing the Octave-Pythonic package. | |||
* Fix the storage of non-expressions by working with upstream SymPy: currently we rely on deprecated functionality in SymPy. | |||
* Improvements and fixes to classdef-related issues in Octave itself. | |||
* Developing the Octave Jupyter kernel. | |||
* '''Project size''' [[#Project sizes | [?]]] and '''Difficulty''' | |||
: ~350 hours (medium) | |||
* '''Required skills''' | |||
: ??? | |||
* '''Potential mentors''' | |||
: ??? | |||
--> | |||
= Project sizes = | = Project sizes = | ||
As of 2024, possible project sizes are 90 (small), 175 (medium), or 350 hours (large) <ref>https://developers.google.com/open-source/gsoc/faq#how_much_time_does_gsoc_participation_take</ref>. | |||
= Footnotes = | = Footnotes = | ||