Summer of Code - Getting Started: Difference between revisions

Jump to navigation Jump to search

Summer of Code - Getting Started (edit)

Revision as of 11:00, 26 January 2023

2,285 bytes removed ,  26 January 2023
→‎Improve TIFF image support: removed (done in GSoC 2022)
(Announce GSoC.)
(→‎Improve TIFF image support: removed (done in GSoC 2022))
(20 intermediate revisions by 7 users not shown)
Line 1: Line 1:
{{Note|GNU Octave is a [https://summerofcode.withgoogle.com/programs/2022/organizations/gnu-octave mentoring organization for GSoC 2022].}}
{{Note|GNU Octave is applying to be a [https://summerofcode.withgoogle.com/programs/2023/organizations/gnu-octave mentoring organization for GSoC 2023].}}


Since 2011 the GNU Octave project has successfully mentored:
Since 2011 the GNU Octave project has successfully mentored:
Line 59: Line 59:


{{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 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'''
: ~175 hours (easy)
* '''Required skills'''
: Octave, C/C++
* '''Potential mentors'''
: [https://octave.discourse.group/u/cdf Carlo de Falco], [https://octave.discourse.group/u/siko1056 Kai]


== ode15{i,s} : Matlab Compatible DAE solvers ==
== ode15{i,s} : Matlab Compatible DAE solvers ==
Line 78: Line 65:
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}}].
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.
The {{manual|decic}} function for selecting consistent initial conditions for ode15i can be made more Matlab compatible by using [http://dx.doi.org/10.1515/JNMA.2002.291 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'''
Line 87: Line 74:
: 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]


== Using Python within Octave ==
== Symbolic package ==


[[Pythonic]] allows one to call Python functions and interact with Python objects from within Octave .m file code and from the Octave command line interface.  Pythonic may eventually not be a separate package, but rather a core feature of Octave.  This project aims to improve Pythonic with the goal of making the package more stable, maintainable, and full-featured.
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 much of the 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 a GSoC project successfully re-implemented this communication using the new [[Pythonic|Pythonic package]].  In 2022, a GSoC project revitalized and improved the maintainability of the package.


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?
Possible ideas for improving the Symbolic package:
 
* exposing more functionality of SymPy with ''less glue'' in between. For example, we could allow OO-style method calls such as <code>f.diff(x)</code> as well as <code>diff(f, x)</code>.
* '''Project size''' [[#Project sizes | [?]]] and '''Difficulty'''
* Fix the storage of non-expressions by working with upstream SymPy: currently we rely on deprecated functionality in SymPy.
: ~350 hours (medium)
* Fix classdef-related issues in Octave itself.
* '''Required skills'''
: Octave, C/C++, Python
* '''Potential mentors'''
: [https://octave.discourse.group/u/mtmiller Mike Miller], [https://octave.discourse.group/u/cbm Colin B. Macdonald], Abhinav Tripathi
 
== Improve TIFF image support ==
 
[https://en.wikipedia.org/wiki/TIFF Tag Image File Format (TIFF)] is the de facto standard for scientific images.  Octave uses the [http://www.graphicsmagick.org/ GraphicsMagic] (GM) C++ library to handle [http://www.graphicsmagick.org/formats.html TIFF and many others image formats]. However, GM still has several limitations:
 
* GM has build option {{codeline|quantum}} which defines the bitdepth to use when reading an image:
** Building GM with '''high quantum''' means that images of smaller bitdepth will take a lot more memory when reading.
** Building GM with '''low quantum''' will make it impossible to read images of higher bitdepth. It also means that the image needs to always be rescaled to the correct range.
* GM supports unsigned integers only, thus incorrectly reading files such as TIFF with floating-point data.
* GM hides details of the image such as whether the image file is indexed.  This makes it hard to access the real data stored on file.
 
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 | [?]]] and '''Difficulty'''
: ~350 hours (medium)
* '''Required skills'''
: Octave, C/C++
* '''Potential mentors'''
: [https://octave.discourse.group/u/carandraug Carnë Draug]


== PolarAxes and Plotting Improvements ==
== PolarAxes and Plotting Improvements ==
Line 141: Line 105:
: Octave, C/C++
: Octave, C/C++
* '''Potential mentors'''
* '''Potential mentors'''
: [https://octave.discourse.group/u/siko1056 Kai]
: [https://octave.discourse.group/u/siko1056 Kai] [https://octave.discourse.group/u/Abdallah_Elshamy Abdallah]


== YAML encoding/decoding ==
== YAML encoding/decoding ==
Line 159: Line 123:


* '''Project size''' [[#Project sizes | [?]]] and '''Difficulty'''
* '''Project size''' [[#Project sizes | [?]]] and '''Difficulty'''
: ~350 hours (easy)
: ~175 hours (easy)
* '''Required skills'''
* '''Required skills'''
: Octave, C/C++
: Octave, C/C++
* '''Potential mentors'''
* '''Potential mentors'''
: [https://octave.discourse.group/u/siko1056 Kai]
: [https://octave.discourse.group/u/siko1056 Kai], [https://octave.discourse.group/u/Abdallah_Elshamy Abdallah]
 
== 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'''
: ~350 hours (medium)
* '''Required skills'''
: Octave, C/C++, Python; object-oriented programming (OOP) in Octave
* '''Potential mentors'''
: [https://octave.discourse.group/u/cbm Colin B. Macdonald], [https://octave.discourse.group/u/mtmiller Mike Miller], Abhinav Tripathi


== TISEAN package ==
== TISEAN package ==
Line 188: Line 139:
* '''Potential mentors'''
* '''Potential mentors'''
: [https://octave.discourse.group/u/kakila KaKiLa]
: [https://octave.discourse.group/u/kakila KaKiLa]
== Better tab completion ==
Links: [https://savannah.gnu.org/bugs/index.php?62492 https://savannah.gnu.org/bugs/index.php?62492] and [https://savannah.gnu.org/bugs/?53384 https://savannah.gnu.org/bugs/?53384]
Description: currently pressing Tab at the Octave command prompt attempts autocompletion of all identifiers in scope (variables, functions, classdefs etc) as well as files and directories in the path. It is not context sensitive.
Project: Improve tab completion. For example,
* Typing
: load x
and then pressing tab should ideally give all loadable files and directories starting with x, not unrelated results like variables or functions.
* Typing
:cd
and tab should only give directories.
* Any file and directory names that are included in the results should include those with spaces and special characters including those that would be interpreted as operators by Octave.
* Typing commands like
: axis
or
: format
and pressing tab should give only those options relevant to that command. E.g. format can be followed by short / long / loose / compact etc but not by a file or variable. Similarly axis can be followed by ij / xy / tight / equal / actual limits etc but not by files or directories. And so on for other commands. This should be made possible for both preexisting commands and for yet-to-be-written commands without any rewriting of existing function code or documentation.
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.
== 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.
This project can be a GSoC for a student who understands 3D graphics rendering.


= Project sizes =
= Project sizes =
Retrieved from "https://wiki.octave.org/Special:MobileDiff/14229...14597"

Navigation menu