Summer of Code - Getting Started: Difference between revisions

Jump to navigation Jump to search
Many updates for GSoC 2022
(Many updates for GSoC 2022)
Line 67: Line 67:
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.
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'''
: ~350 hours
* '''Required skills'''
* '''Required skills'''
: Knowledge of Octave, C/C++; familiarity with numerical methods for DAEs
: Octave, C/C++; familiarity with numerical methods for DAEs
* '''Potential mentors'''
* '''Potential mentors'''
: Francesco Faccio, Carlo de Falco, Marco Caliari, Jacopo Corno, 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]


== Using Python within Octave ==
== Using Python within Octave ==
Line 78: Line 80:
Based on a previous summer project related to Pythonic, this work will consist of fast-paced collaborative software development based on tackling the [https://gitlab.com/mtmiller/octave-pythonic/issues Pythonic issue list].  You would also be expected to participate in software design decisions and discussion, as well as improve documentation, doctests, and unit tests.  As an example of the sorts of decisions being made, note that Octave indexes from 1 whereas Python typically indexes from 0; in which cases is it appropriate to make this transparent to the user?
Based on a previous summer project related to Pythonic, this work will consist of fast-paced collaborative software development based on tackling the [https://gitlab.com/mtmiller/octave-pythonic/issues Pythonic issue list].  You would also be expected to participate in software design decisions and discussion, as well as improve documentation, doctests, and unit tests.  As an example of the sorts of decisions being made, note that Octave indexes from 1 whereas Python typically indexes from 0; in which cases is it appropriate to make this transparent to the user?


* '''Project size'''
: ~350 hours
* '''Required skills'''
* '''Required skills'''
: Knowledge of Octave, C/C++, Python
: Octave, C/C++, Python
* '''Potential mentors'''
* '''Potential mentors'''
: Mike Miller, Colin B. Macdonald, Abhinav Tripathi
: [https://octave.discourse.group/u/mtmiller Mike Miller], [https://octave.discourse.group/u/cbm Colin B. Macdonald], Abhinav Tripathi


== Improve TIFF image support ==
== Improve TIFF image support ==
Line 95: Line 99:
This project aims to implement better TIFF image support using [https://en.wikipedia.org/wiki/Libtiff libtiff], while leaving GM handle all other image formats.  After writing a [https://octave.org/doc/v6.1.0/classdef-Classes.html classdef] interface to libtiff, improve the Octave functions {{manual|imread}}, {{manual|imwrite}}, and {{manual|imfinfo}} to make use of it.
This project aims to implement better TIFF image support using [https://en.wikipedia.org/wiki/Libtiff libtiff], while leaving GM handle all other image formats.  After writing a [https://octave.org/doc/v6.1.0/classdef-Classes.html classdef] interface to libtiff, improve the Octave functions {{manual|imread}}, {{manual|imwrite}}, and {{manual|imfinfo}} to make use of it.


* '''Project size'''
: ~350 hours
* '''Required skills'''
* '''Required skills'''
: Knowledge of Octave, C/C++
: Octave, C/C++
* '''Potential mentors'''
* '''Potential mentors'''
: Carnë Draug
: [https://octave.discourse.group/u/carandraug Carnë Draug]


== PolarAxes and Plotting Improvements ==
== PolarAxes and Plotting Improvements ==
Line 104: Line 110:
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}}.
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'''
: ~350 hours
* '''Required skills'''
* '''Required skills'''
: Knowledge of Octave, C/C++; optional experience with OpenGL programming
: Octave, C/C++; optional experience with OpenGL programming
* '''Potential mentors'''
* '''Potential mentors'''
: Rik  
: [https://octave.discourse.group/u/rik Rik]


== Table datatype ==
== Table datatype ==
Line 115: Line 123:
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.
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.


* '''Project size'''
: ~350 hours
* '''Required skills'''
* '''Required skills'''
: Knowledge of Octave, C/C++
: Octave, C/C++
* '''Potential mentors'''
* '''Potential mentors'''
: [[User:siko1056|Kai]]
: [https://octave.discourse.group/u/siko1056 Kai]


== Adding functionality to packages ==
== YAML encoding/decoding ==
 
=== 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]].
[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]].
Line 135: Line 143:
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.
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 immediatly from Octave as package and is backwards-compatible with older Octaver versions.
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.
 
* '''Required skills'''
: Knowledge of Octave and C/C++
* '''Potential mentors'''
: [[User:siko1056|Kai]]
 
 
<!-- === OCS package ===
 
The [[Ocs package | OCS package]] is a circuit simulator. The objective of this project is to increase compatibility with [https://en.wikipedia.org/wiki/SPICE SPICE] and improve compatibility with other Octave packages, e.g. the [[Control package]].  Please study the [https://octave.sourceforge.io/ocs/overview.html available functions] of this package.  


* '''Project size'''
: ~350 hours
* '''Required skills'''
* '''Required skills'''
: Knowledge of Octave, C/C++; FORTRAN API knowledge
: Octave, C/C++
* '''Potential mentors'''
* '''Potential mentors'''
: Sebastian Schöps, Carlo de Falco -->
: [https://octave.discourse.group/u/siko1056 Kai]


=== Symbolic package ===
== 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]].
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]].
Line 158: Line 158:
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>.
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'''
: ~350 hours
* '''Required skills'''
* '''Required skills'''
: Knowledge of Octave, C/C++, Python; object-oriented programming (OOP) in Octave
: Octave, C/C++, Python; object-oriented programming (OOP) in Octave
* '''Potential mentors'''
* '''Potential mentors'''
: Colin B. Macdonald, Mike Miller, Abhinav Tripathi
: [https://octave.discourse.group/u/cbm Colin B. Macdonald], [https://octave.discourse.group/u/mtmiller Mike Miller], Abhinav Tripathi


=== TISEAN package ===
== 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.  Which are of importance for many scientific disciplines involving statistical computations and signal processing.
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.  Which are of importance for many scientific disciplines involving statistical computations and signal processing.
 
* '''Project size'''
: ~350 hours
* '''Required skills'''
* '''Required skills'''
: Knowledge of Octave, C/C++; FORTRAN API knowledge
: Octave, C/C++; FORTRAN API knowledge
* '''Potential mentors'''
* '''Potential mentors'''
: [[User:KaKiLa|KaKiLa]]
: [https://octave.discourse.group/u/kakila KaKiLa]


[[Category:Summer of Code]]
[[Category:Summer of Code]]
[[Category:Project Ideas]]
[[Category:Project Ideas]]

Navigation menu