Editing Summer of Code - Getting Started
The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then publish the changes below to finish undoing the edit.
Latest revision | Your text | ||
Line 1: | Line 1: | ||
{{Note|GNU Octave is a [https://summerofcode.withgoogle.com/programs/ | {{Note|GNU Octave is a [https://summerofcode.withgoogle.com/programs/2022/organizations/gnu-octave mentoring organization for GSoC 2022].}} | ||
Since 2011 the GNU Octave project has successfully mentored: | Since 2011 the GNU Octave project has successfully mentored: | ||
* [[Summer of Code | ''' | * [[Summer of Code | '''37 participants''' ๐]] | ||
* [[Summer of Code | ''' | * [[Summer of Code | '''39 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]] | #* Join [https://octave.discourse.group/ '''Octave Discourse'''] or [[IRC]]. 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] | 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. | ||
{{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.}} | ||
== | == openlibm == | ||
Over the years Octave faced many issues (see [[openlibm | the openlibm page in this wiki]] for examples) about different [https://en.wikipedia.org/wiki/C_mathematical_functions#libm C mathematical functions library] (in short: "libm") implementations on various systems.ย To overcome similar issues, developers of the [https://en.wikipedia.org/wiki/Julia_(programming_language) Julia Programming Language] started the [https://openlibm.org/ openlibm] project "to have a good libm [ ...] that work[s] consistently across compilers and operating systems, and in 32-bit and 64-bit environments".ย openlibm is supported by major Linux distributions (e.g. [https://packages.ubuntu.com/focal/libopenlibm-dev Debian/Ubuntu], [https://src.fedoraproject.org/rpms/openlibm RHEL/Fedora],[https://software.opensuse.org/package/openlibm SLES/openSUSE], ...) and the [https://hg.octave.org/mxe-octave/rev/480f60641fc2 MS Windows MXE package] was added as well. | |||
ย | |||
This project consists of learning about the usage of [https://en.wikipedia.org/wiki/GNU_Autotools GNU Autotools] in Octave and ways to detect openlibm.ย As the next step the Octave code base has to be reviewed under the guidance of a mentor and relevant code changes should be performed.ย Finally, relevant code changes in the [[Tests | Octave test suite]] are performed and tested on various Linux, MS Windows, and macOS machines with the help of the Octave community. | |||
* '''Project size''' [[#Project sizes | [?]]] and '''Difficulty''' | * '''Project size''' [[#Project sizes | [?]]] and '''Difficulty''' | ||
: ~ | : ~175 hours (easy) | ||
* '''Required skills''' | * '''Required skills''' | ||
: Octave, | : Octave, C/C++, Autotools | ||
* '''Potential mentors''' | * '''Potential mentors''' | ||
: [https://octave.discourse.group/u/ | : [https://octave.discourse.group/u/cdf Carlo de Falco], [https://octave.discourse.group/u/siko1056 Kai] | ||
== | == ode15{i,s} : Matlab Compatible DAE solvers == | ||
An initial implementation of Matlab compatible Differential Algebraic Equations (DAE) solvers, {{manual|ode15i}} and {{manual|ode15s}}, based on [https://computing.llnl.gov/projects/sundials SUNDIALS], ย | |||
was done by [https://gsoc2016ode15s.blogspot.com/ Francesco Faccio during GSoC 2016]. The code is maintained in the main Octave repository and consists mainly of the following three files: [https://hg.savannah.gnu.org/hgweb/octave/file/tip/libinterp/dldfcn/__ode15__.cc {{path|libinterp/dldfcn/__ode15__.cc}}], [https://hg.savannah.gnu.org/hgweb/octave/file/tip/scripts/ode/ode15i.m {{path|scripts/ode/ode15i.m}}] and [https://hg.savannah.gnu.org/hgweb/octave/file/tip/scripts/ode/ode15s.m {{path|scripts/ode/ode15s.m}}]. | |||
The {{manual|decic}} function for selecting consistent initial conditions for ode15i can be made more Matlab compatible by using [https://faculty.smu.edu/shampine/cic.pdf another algorithm].ย Another useful extension is to make ode15{i,s} work with datatypes other than double and to improve interpolation at intermediate time steps. | |||
ย | |||
ย | |||
* '''Project size''' [[#Project sizes | [?]]] and '''Difficulty''' | * '''Project size''' [[#Project sizes | [?]]] and '''Difficulty''' | ||
: ~350 hours ( | : ~350 hours (medium) | ||
* '''Required skills''' | * '''Required skills''' | ||
: Octave | : Octave, C/C++; familiarity with numerical methods for DAEs | ||
* '''Potential mentors''' | * '''Potential mentors''' | ||
: [https://octave.discourse.group/u/ | : 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] | ||
== Symbolic package == | |||
The [[Symbolic package]] provides symbolic computing and other [https://en.wikipedia.org/wiki/Computer_algebra_system computer algebra system] tools.ย The main component of Symbolic is a pure m-file class "@sym" which uses the Python package [https://www.sympy.org SymPy] to do (most of) the actual computations.ย The package aims to expose the full functionality of SymPy while also providing a high level of compatibility with the Matlab Symbolic Math Toolbox.ย The Symbolic package requires communication between Octave and Python.ย In 2016 another GSoC project successfully re-implemented this communication using the new [[Pythonic|Pythonic package]]. | |||
This project proposes to go further: instead of using Pythonic only for the communication layer, we'll use it throughout the Symbolic project. For example, we might make "@sym" a subclass of "@pyobject". We also could stop using the "python_cmd" interface and use Pythonic directly from methods.ย The main goal was already mentioned: to expose the ''full functionality'' of SymPy. For example, we would allow OO-style method calls such as <code>f.diff(x)</code> instead of <code>diff(f, x)</code>. | |||
ย | |||
* '''Project size''' [[#Project sizes | [?]]] and '''Difficulty''' | * '''Project size''' [[#Project sizes | [?]]] and '''Difficulty''' | ||
: ~350 hours (medium) | : ~350 hours (medium) | ||
* '''Required skills''' | * '''Required skills''' | ||
: Octave, C/C++; | : Octave, C/C++, Python; object-oriented programming (OOP) in Octave | ||
* '''Potential mentors''' | * '''Potential mentors''' | ||
: | : [https://octave.discourse.group/u/cbm Colin B. Macdonald], [https://octave.discourse.group/u/mtmiller Mike Miller], Abhinav Tripathi | ||
== PolarAxes and Plotting Improvements == | == PolarAxes and Plotting Improvements == | ||
Octave currently provides | Octave currently provides supports 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 127: | Line 110: | ||
* '''Potential mentors''' | * '''Potential mentors''' | ||
: [https://octave.discourse.group/u/rik Rik] | : [https://octave.discourse.group/u/rik Rik] | ||
== Table datatype == | == Table datatype == | ||
Line 141: | Line 122: | ||
: Octave, C/C++ | : Octave, C/C++ | ||
* '''Potential mentors''' | * '''Potential mentors''' | ||
: | : [https://octave.discourse.group/u/siko1056 Kai] [https://octave.discourse.group/u/Abdallah_Elshamy Abdallah] | ||
== YAML encoding/decoding == | |||
== | |||
[https://en.wikipedia.org/wiki/YAML YAML], is a very common human readable and structured data format.ย Unfortunately, GNU Octave (and Matlab) still lacks of builtin support of that omnipresent data format.ย Having YAML support, Octave can easily read and write config files, which often use YAML or JSON.ย The latter JSON format has been [[Summer of Code#GSoC_2020 | successfully implemented for Octave during GSoC 2020]]. | |||
The goal of this project is to repeat the GSoC 2020 success story with [https://github.com/biojppm/rapidyaml Rapid YAML] or another fast C/C++ library. | |||
The first step is research about existing Octave/Matlab and C/C++ implementations, for example: | |||
* https://code.google.com/archive/p/yamlmatlab/ (uses Java) | |||
* http://vision.is.tohoku.ac.jp/~kyamagu/ja/software/yaml/ (uses Java) | |||
Then evaluate (and to cherry pick from) existing implementations above, compare strength and weaknesses.ย After this, an Octave package containing en- and decoding functions (for example <code>yamlencode</code> and <code>yamldecode</code>) shall be created.ย This involves proper documentation of the work and unit tests to ensure the correctness of the implementation. | |||
Finally, the package is considered to be merged into core Octave, probably after the GSoC project. However, it can be used immediately from Octave as package and is backwards-compatible with older Octave versions. | |||
ย | |||
ย | |||
ย | |||
ย | |||
ย | |||
* '''Project size''' [[#Project sizes | [?]]] and '''Difficulty''' | * '''Project size''' [[#Project sizes | [?]]] and '''Difficulty''' | ||
: ~350 hours ( | : ~350 hours (easy) | ||
* '''Required skills''' | * '''Required skills''' | ||
: | : Octave, C/C++ | ||
* '''Potential mentors''' | * '''Potential mentors''' | ||
: | : [https://octave.discourse.group/u/siko1056 Kai], [https://octave.discourse.group/u/Abdallah_Elshamy Abdallah] | ||
== TISEAN package == | |||
== | |||
The [[TISEAN package]] provides an Octave interface to [https://www.pks.mpg.de/~tisean/Tisean_3.0.1/index.html TISEAN] is a suite of code for nonlinear time series analysis.ย In 2015, another GSoC project started with the work to create interfaces to many TISEAN functions, but [[TISEAN_package:Procedure | there is still work left to do]].ย There are missing functions to do computations on spike trains, to simulate autoregresive models, to create specialized plots, etc. These are of importance for many scientific disciplines involving statistical computations and signal processing. | |||
* '''Project size''' [[#Project sizes | [?]]] and '''Difficulty''' | * '''Project size''' [[#Project sizes | [?]]] and '''Difficulty''' | ||
: ~350 hours (medium) | : ~350 hours (medium) | ||
* '''Required skills''' | * '''Required skills''' | ||
: | : Octave, C/C++; FORTRAN API knowledge | ||
* '''Potential mentors''' | * '''Potential mentors''' | ||
: | : [https://octave.discourse.group/u/kakila KaKiLa] | ||
ย | |||
ย | |||
ย | |||
ย | |||
= Project sizes = | = Project sizes = | ||
Since GSoC 2022 there exist two project sizes<ref>https://groups.google.com/g/google-summer-of-code-announce/c/_ekorpcglB8</ref><ref>https://google.github.io/gsocguides/mentor/defining-a-project-ideas-list</ref>: | |||
* '''~175 hours''' (~12 weeks, Jun 13 - Sept 12) | |||
* '''~350 hours''' (~22 weeks, Jun 13 - Nov 21) | |||
= Footnotes = | = Footnotes = |