Summer of Code - Getting Started: Difference between revisions

→‎Suggested projects: Add Difficulty
m (→‎openlibm: typo)
(→‎Suggested projects: Add Difficulty)
Line 66: Line 66:
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.
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 | [?]]]
* '''Project size''' [[#Project sizes | [?]]] and '''Difficulty'''
: ~175 hours
: ~175 hours (easy)
* '''Required skills'''
* '''Required skills'''
: Octave, C/C++
: Octave, C/C++
Line 80: Line 80:
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''' [[#Project sizes | [?]]]
* '''Project size''' [[#Project sizes | [?]]] and '''Difficulty'''
: ~350 hours
: ~350 hours (medium)
* '''Required skills'''
* '''Required skills'''
: Octave, C/C++; familiarity with numerical methods for DAEs
: Octave, C/C++; familiarity with numerical methods for DAEs
Line 93: Line 93:
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''' [[#Project sizes | [?]]]
* '''Project size''' [[#Project sizes | [?]]] and '''Difficulty'''
: ~350 hours
: ~350 hours (medium)
* '''Required skills'''
* '''Required skills'''
: Octave, C/C++, Python
: Octave, C/C++, Python
Line 112: Line 112:
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''' [[#Project sizes | [?]]]
* '''Project size''' [[#Project sizes | [?]]] and '''Difficulty'''
: ~350 hours
: ~350 hours (medium)
* '''Required skills'''
* '''Required skills'''
: Octave, C/C++
: Octave, C/C++
Line 123: Line 123:
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''' [[#Project sizes | [?]]]
* '''Project size''' [[#Project sizes | [?]]] and '''Difficulty'''
: ~350 hours
: ~350 hours (medium)
* '''Required skills'''
* '''Required skills'''
: Octave, C/C++; optional experience with OpenGL programming
: Octave, C/C++; optional experience with OpenGL programming
Line 136: Line 136:
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''' [[#Project sizes | [?]]]
* '''Project size''' [[#Project sizes | [?]]] and '''Difficulty'''
: ~350 hours
: ~350 hours (hard)
* '''Required skills'''
* '''Required skills'''
: Octave, C/C++
: Octave, C/C++
Line 158: Line 158:
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.
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 | [?]]]
* '''Project size''' [[#Project sizes | [?]]] and '''Difficulty'''
: ~350 hours
: ~350 hours (easy)
* '''Required skills'''
* '''Required skills'''
: Octave, C/C++
: Octave, C/C++
Line 171: Line 171:
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''' [[#Project sizes | [?]]]
* '''Project size''' [[#Project sizes | [?]]] and '''Difficulty'''
: ~350 hours
: ~350 hours (medium)
* '''Required skills'''
* '''Required skills'''
: Octave, C/C++, Python; object-oriented programming (OOP) in Octave
: Octave, C/C++, Python; object-oriented programming (OOP) in Octave
Line 182: Line 182:
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.
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 | [?]]]
* '''Project size''' [[#Project sizes | [?]]] and '''Difficulty'''
: ~350 hours
: ~350 hours (medium)
* '''Required skills'''
* '''Required skills'''
: Octave, C/C++; FORTRAN API knowledge
: Octave, C/C++; FORTRAN API knowledge