Summer of Code - Getting Started: Difference between revisions

Jump to navigation Jump to search

Summer of Code - Getting Started (edit)

Revision as of 23:33, 6 September 2018

2,017 bytes removed ,  6 September 2018
Removed "Command line suggestion feature" project because this was done in GSoC 2018 (https://sudeepam.blogspot.com/)
(→‎Summary table: Update short info about the interval package.)
(Removed "Command line suggestion feature" project because this was done in GSoC 2018 (https://sudeepam.blogspot.com/))
(26 intermediate revisions by 10 users not shown)
Line 1: Line 1:
The following is distilled from the [[Projects]] page for the benefit of potential [https://summerofcode.withgoogle.com Google] and [http://sophia.estec.esa.int/socis ESA] Summer of Code (SoC) students. Although students are welcome to attempt any of the projects in that page or any of their own choosing, here we offer some suggestions on what good student projects might be.
The following is distilled from the [[Projects]] page for the benefit of potential [https://summerofcode.withgoogle.com Google] and [http://sophia.estec.esa.int/socis ESA] Summer of Code (SoC) students. Although students are welcome to attempt any of the projects in that page or any of their own choosing, here we offer some suggestions on what good student projects might be.
You can also take a look at last years [[Summer of Code]] projects for inspiration.


= Steps Toward a Successful Application =
= Steps Toward a Successful Application =
Line 9: Line 11:
* '''Do not wait for us to tell you what to do'''
* '''Do not wait for us to tell you what to do'''
*: You should be doing something that interests you, and should not need us to tell you what to do.  Similarly, you shouldn't ask us what to do either.
*: You should be doing something that interests you, and should not need us to tell you what to do.  Similarly, you shouldn't ask us what to do either.
*:* When you email the list and mentors, do not write it to say on what project you're interested. Be specific about your questions and clear on the email subject. For example, do not write an email with the subject "GSoC student interested in the ND images projects".  Such email is likely be ignored.  Instead, show you are already working on the topic, and email "Problem implementing morphological operators with bitpacked ND images".
*:* When you email the list and mentors, do not write it to say in what project you're interested. Be specific about your questions and clear on the email subject. For example, do not write an email with the subject "GSoC student interested in the ND images projects".  Such email is likely be ignored.  Instead, show you are already working on the topic, and email "Problem implementing morphological operators with bitpacked ND images".
*:* It is good to ask advice on how to solve something you can't but you must show some work done.  Remember, we are mentors and not your boss.  Read [http://www.catb.org/esr/faqs/smart-questions.html How to ask questions the smart way]:
*:* It is good to ask advice on how to solve something you can't but you must show some work done.  Remember, we are mentors and not your boss.  Read [http://www.catb.org/esr/faqs/smart-questions.html How to ask questions the smart way]:
*:*: <blockquote cite="http://www.catb.org/esr/faqs/smart-questions.html">''Prepare your question. Think it through. Hasty-sounding questions get hasty answers, or none at all. The more you do to demonstrate that having put thought and effort into solving your problem before seeking help, the more likely you are to actually get help.''</blockquote>
*:*: <blockquote cite="http://www.catb.org/esr/faqs/smart-questions.html">''Prepare your question. Think it through. Hasty-sounding questions get hasty answers, or none at all. The more you do to demonstrate that having put thought and effort into solving your problem before seeking help, the more likely you are to actually get help.''</blockquote>
*:* It can be difficult at the beginning to think on something to do.  This is nature of free and open source software development.  You will need to break the mental barrier that prevents you from thinking on what can be done.  Once you do that, you will have no lack of ideas for what to do next.
*:* It can be difficult at the beginning to think on something to do.  This is nature of free and open source software development.  You will need to break the mental barrier that prevents you from thinking on what can be done.  Once you do that, you will have no lack of ideas for what to do next.
*:* Use Octave.  Eventually you will come accross somethings that does not work the way you like.  Fix that.  Or you will come accross a missing function.  Implement it.  It may be a difficult problem (they usually are) but while solving that problem you may find other missing functions ().  Implemenent and contribute those to Octave.
*:* Use Octave.  Eventually you will come across something that does not work the way you like.  Fix that.  Or you will come across a missing function.  Implement it.  It may be a hard problem (they usually are). While solving that problem, you may find other missing capabilities or smaller bug fixes.  Implement and contribute those to Octave.
*:* Take a look at the [[Short projects]] for something that may be simple to start with.
*:* Take a look at the [[Short projects]] for something that may be simple to start with.
==  Find Something That Interests You ==  
==  Find Something That Interests You ==  
*: It's '''critical''' that you '''find a project that excites you'''.  You'll be spending most of the summer working on it (we expect you to treat the SoC as a full-time job).
*: It's '''critical''' that you '''find a project that excites you'''.  You'll be spending most of the summer working on it (we expect you to treat the SoC as a full-time job).
Line 36: Line 39:
*: While you generally don't need to understand too much unless you actually want to change how Octave is built, you should be able to understand enough to get a general idea of how to build Octave.
*: While you generally don't need to understand too much unless you actually want to change how Octave is built, you should be able to understand enough to get a general idea of how to build Octave.
*: If you've ever done a {{Codeline|configure && make && make install}} series of commands, you have already used the GNU build system.
*: If you've ever done a {{Codeline|configure && make && make install}} series of commands, you have already used the GNU build system.
*: '''You must demonstrate that you are able to build the development version of Octave from sources before the application deadline.''' You will be able to find instructions how to it on this wiki, and the manual. Linux is arguably the easiest system to work on.
*: '''You must demonstrate that you are able to build the development version of Octave from sources before the application deadline.''' Linux is arguably the easiest system to work on. Instructions:
*:* [[Building]]
*:* [[Building]]
*:* [https://www.gnu.org/software/octave/doc/interpreter/Installation.html Octave Manual on Installing Octave]
*:* [https://www.gnu.org/software/octave/doc/interpreter/Installation.html Octave Manual on Installing Octave]
* '''The Version Control System'''
* '''The Version Control System'''
*: We use [http://mercurial.selenic.com/ Mercurial] (abbreviated hg).
*: We use [https://www.mercurial-scm.org/ Mercurial] (abbreviated hg).
*: Mercurial is the [http://en.wikipedia.org/wiki/Distributed_Version_Control_System distributed version control system] (DVCS) we use for managing our source code. You should have some basic understanding of how a DVCS works, but hg is pretty easy to pick up, especially if you already know a VCS like git or svn.
*: Mercurial is the [http://en.wikipedia.org/wiki/Distributed_Version_Control_System distributed version control system] (DVCS) we use for managing our source code. You should have some basic understanding of how a DVCS works, but hg is pretty easy to pick up, especially if you already know a VCS like git or svn.
* '''The Procedure for Contributing Changesets'''
* '''The Procedure for Contributing Changesets'''
*: You will be expected to follow the same procedures as other contributors and core developers.
*: You will be expected to follow the same procedures as other contributors and core developers.
*: You will be helping current and future Octave developers by using our standard style for changes, commit messages, and so on.  You should also read the same [https://www.gnu.org/software/octave/doc/interpreter/Contributing-Guidelines.html contribution] [http://hg.savannah.gnu.org/hgweb/octave/file/tip/etc/HACKING guidelines] we have for everyone.
*: You will be helping current and future Octave developers by using our standard style for changes, commit messages, and so on.  You should also read the same [[Contribution guidelines | contribution]] [http://hg.savannah.gnu.org/hgweb/octave/file/tip/etc/HACKING.md guidelines] we have for everyone.
*: [[Hg_instructions_for_mentors#Mercurial_Tips_for_SoC_students | This page]] describes the procedures students are expected to use to publicly display their progress in a public mercurial repo during their work.
*: [[Hg_instructions_for_mentors#Mercurial_Tips_for_SoC_students | This page]] describes the procedures students are expected to use to publicly display their progress in a public mercurial repo during their work.
* '''The Maintainers Mailing List'''
* '''The Maintainers Mailing List'''
Line 55: Line 58:
*: Unless your primary mentor has a strong preference for some other method of communication, the IRC channel will likely be your primary means of communicating with your mentor and Octave developers.
*: Unless your primary mentor has a strong preference for some other method of communication, the IRC channel will likely be your primary means of communicating with your mentor and Octave developers.
* '''The Octave Forge Project'''
* '''The Octave Forge Project'''
*: [http://octave.sf.net Octave-Forge] is a collection of contributed packages that enhance the capabilities of core Octave. They are somewhat analogous to Matlab's toolboxes.
*: [https://octave.sourceforge.io/ Octave-Forge] is a collection of contributed packages that enhance the capabilities of core Octave. They are somewhat analogous to Matlab's toolboxes.
* '''Related Skills'''
* '''Related Skills'''
*: In addition, you probably should know '''some''' mathematics, engineering, experimental science, or something of the sort.
*: In addition, you probably should know '''some''' mathematics, engineering, experimental science, or something of the sort.
Line 95: Line 98:
|-
|-
! <br />!! !! !! !! !! !!
! <br />!! !! !! !! !! !!
|-
| [[Summer_of_Code_Project_Ideas#Make_specfuns_special_again | Make specfuns special again]] || Marco Caliari || Colin Macdonald || Numerical || Yes  || Medium || GSoC 2017
|-
|-
| [[Summer_of_Code_Project_Ideas#ode15s_:_Matlab_Compatible_DAE_solver | ode15{i,s} : Matlab Compatible DAE solvers]] || Carlo de Falco || Francesco Faccio, Marco Caliari, Jacopo Corno, Sebastian Schöps || Numerical || No  || Medium || GSoC 2016
| [[Summer_of_Code_Project_Ideas#ode15s_:_Matlab_Compatible_DAE_solver | ode15{i,s} : Matlab Compatible DAE solvers]] || Carlo de Falco || Francesco Faccio, Marco Caliari, Jacopo Corno, Sebastian Schöps || Numerical || No  || Medium || GSoC 2016
Line 103: Line 104:
|-
|-
| [[Summer_of_Code_Project_Ideas#Improve_iterative_methods_for_sparse_linear_systems | Improve iterative methods for sparse linear systems]] || Marco Caliari || Carlo de Falco || Numerical || No  || Hard || SOCIS 2016
| [[Summer_of_Code_Project_Ideas#Improve_iterative_methods_for_sparse_linear_systems | Improve iterative methods for sparse linear systems]] || Marco Caliari || Carlo de Falco || Numerical || No  || Hard || SOCIS 2016
|-
| [[Summer_of_Code_Project_Ideas#Neural Networks package: Convolutional Neural Networks | Neural Networks package: Convolutional Neural Networks]] || [[User:Francesco Faccio|Francesco Faccio]] || Ankit || Octave Forge || Yes  || Hard|| Never
|-
|-
| [[Summer_of_Code_Project_Ideas#EPA_hydrology_software_suite | EPA hydrology software suite]] || [[User:KaKiLa| KaKiLa]] || ? || Octave Forge || Yes || Medium || Never
| [[Summer_of_Code_Project_Ideas#EPA_hydrology_software_suite | EPA hydrology software suite]] || [[User:KaKiLa| KaKiLa]] || ? || Octave Forge || Yes || Medium || Never
Line 117: Line 116:
|-
|-
| [[Summer_of_Code_Project_Ideas#Interval_package | Interval package]] || [[User:oheim|Oliver Heimlich]] || [[User:Siko1056|Kai T. Ohlhus]] || Octave Forge, Numerical || No || Medium || [https://gsocinterval.blogspot.de/ GSoC 2017]
| [[Summer_of_Code_Project_Ideas#Interval_package | Interval package]] || [[User:oheim|Oliver Heimlich]] || [[User:Siko1056|Kai T. Ohlhus]] || Octave Forge, Numerical || No || Medium || [https://gsocinterval.blogspot.de/ GSoC 2017]
|-
| [[Summer_of_Code_Project_Ideas#OCS | OCS package]] || Sebastian Schöps || Sebastian Schöps || Octave Forge, Numerical || Yes || Easy || Never
|-
|-
| [[Summer_of_Code_Project_Ideas#Using_Python_within_Octave | Pytave project]] || Mike Miller || Colin B. Macdonald, Abhinav Tripathi || Infrastructure || No  || Medium || some in GSoC 2016
| [[Summer_of_Code_Project_Ideas#Using_Python_within_Octave | Pytave project]] || Mike Miller || Colin B. Macdonald, Abhinav Tripathi || Infrastructure || No  || Medium || some in GSoC 2016
|-
|-
| [[Summer_of_Code_Project_Ideas#Jupyter_Integration | Jupyter integration]] || Mike Miller || Colin B. Macdonald || Infrastructure ||  Yes || Medium || Never
| [[Summer_of_Code_Project_Ideas#Jupyter_Integration | Jupyter integration]] || Mike Miller || Colin B. Macdonald, Ankit Raj || Infrastructure ||  Yes || Medium || Never
|-
| [[Summer_of_Code_Project_Ideas#Chebfun_in_Octave | Chebfun in Octave]] || Colin B. Macdonald || [[User:KaKiLa|KaKiLa]], Ankit Raj, needs core-Octave mentor/comentor || Infrastructure, Numerical || Yes  || Hard || Never
|-
| [[Summer_of_Code_Project_Ideas#GUI Variable Editor and Property Inspector | GUI Property Inspector]] || ? ||  || GUI || Yes  || Medium || Never
|-
|-
| [[Summer_of_Code_Project_Ideas#Chebfun_in_Octave | Chebfun in Octave]] || Colin B. Macdonald || [[User:KaKiLa|KaKiLa]], needs core-Octave mentor/comentor || Infrastructure, Numerical || Yes  || Hard || Never
| [[Summer_of_Code_Project_Ideas#SPQR Interface | Write API to SPQR Library]] || ? || || Infrastructure || Yes  || Medium || Never
|-
|-
| [[Summer_of_Code_Project_Ideas#Octave_code_sharing | Octave code sharing]] || [[User:Siko1056|Kai T. Ohlhus]] || ? || Infrastructure || Yes  || Medium || Never
| [[Summer_of_Code_Project_Ideas#PolarAxes and Plotting Improvements | PolarAxes and Plotting Improvements ]] || ? || Rik || Graphics || Yes  || Medium || Never
|}
|}


Line 130: Line 135:


These projects involve implementing certain mathematical functions, primarily in core Octave.
These projects involve implementing certain mathematical functions, primarily in core Octave.
=== Make specfuns special again ===
Traditionally, problem solving environments like Octave provide simple interfaces to numerical linear algebra, special function evaluation, root finding, and other tools.  Special functions (such as Bessel functions, exponential integrals, LambertW, etc) are expected by users to "just work".  But many of Octave's special functions could be improved to improve their numerical accuracy.  Generally a user might expect these to be accurate to full 15 digits.  Software testing is important to Octave; this project would improve the tests of many special functions, in particular by comparing the output with slow-but-accurate symbolic computations.
State: some bugs include [https://savannah.gnu.org/bugs/?48307 #48307] (sinc), [https://savannah.gnu.org/bugs/?47738  #47738] (expint), [https://savannah.gnu.org/bugs/?47800  #47800] (gammainc), [https://savannah.gnu.org/bugs/?48036 #48036] (gammaincinv) [https://savannah.gnu.org/bugs/index.php?48316 #48316] (besselj) ''TODO: add others?''  The unmaintained specfun pkg had some poor implementations (e.g., divergence for large x, see [https://github.com/cbm755/octsympy/issues/416].).  See also the Symbolic functions in `@double`: these probably should have native double implementations.
* '''Required skills'''
: Octave m-file programming, some familiarity with Approximation Theory (a branch of mathematics).
* '''Difficulty'''
: Medium (mathematics needed, but on the other hand, perhaps little or no C++).
* '''Potential mentors'''
: Marco Caliari, Colin Macdonald, others?
How to get started: pick a special function, see if it has tests: contribute a patch that adds more tests, e.g., comparing its values to symbolic computations or other highly accurate solutions


=== ode15{i,s} : Matlab Compatible DAE solvers ===
=== ode15{i,s} : Matlab Compatible DAE solvers ===
Line 158: Line 148:
[http://hg.savannah.gnu.org/hgweb/octave/file/4890b1c4a6bd/scripts/ode/ode15i.m ode15i.m] and
[http://hg.savannah.gnu.org/hgweb/octave/file/4890b1c4a6bd/scripts/ode/ode15i.m ode15i.m] and
[http://hg.savannah.gnu.org/hgweb/octave/file/4890b1c4a6bd/scripts/ode/ode15s.m ode15s.m].
[http://hg.savannah.gnu.org/hgweb/octave/file/4890b1c4a6bd/scripts/ode/ode15s.m ode15s.m].
The list of outsanding tracker tickets concerning this implementation can be found  
The list of outstanding tracker tickets concerning this implementation can be found  
[https://savannah.gnu.org/search/?Search=Search&words=ode15&type_of_search=bugs&only_group_id=1925&exact=1&max_rows=25#options here]
[https://savannah.gnu.org/search/?Search=Search&words=ode15&type_of_search=bugs&only_group_id=1925&exact=1&max_rows=25#options here]


Possible useful improvements that could be done in a new project include:
Possible useful improvements that could be done in a new project include:


* Implement a better funtion for selecting consistent initial conditions compatible with Matlab's decic.m. The algorithm to use is described [http://faculty.smu.edu/shampine/cic.pdf here]
* Implement a better function for selecting consistent initial conditions compatible with Matlab's decic.m. The algorithm to use is described [http://faculty.smu.edu/shampine/cic.pdf here]


* make ode15{i,s} with datatypes other than double
* make ode15{i,s} with datatypes other than double
Line 174: Line 164:
to a possible project plan would be improving documentation and tests in odepkg and removing  
to a possible project plan would be improving documentation and tests in odepkg and removing  
overlaps with the documentation in core Octave.
overlaps with the documentation in core Octave.
   
   
* '''Required skills'''
* '''Required skills'''
Line 213: Line 202:
=== Chebfun in Octave ===
=== Chebfun in Octave ===


[https://chebfun.org Chebfun] is a mathematics and software project for "numerical computing with functions".  Basically it approximates functions to machine precision accuracy (10<sup>-15</sup>) using piecewise Chebyshev polynomial interpolants.  Operations on those functions (arithmetic, derivatives, root-finding, etc) are then overloaded and return new interpolating polynomials, which are themselves proxies for the actual solution.
[http://chebfun.org Chebfun] is a mathematics and software project for "numerical computing with functions".  Basically it approximates functions to machine precision accuracy (10<sup>-15</sup>) using piecewise Chebyshev polynomial interpolants.  Operations on those functions (arithmetic, derivatives, root-finding, etc) are then overloaded and return new interpolating polynomials, which are themselves proxies for the actual solution.


Chebfun makes extensive use of classdef classes, and is one of the largest Free Software projects to do so.  Unfortunately it currently only works in Matlab.  This project seeks to (1) improve Octave's classdef support and (2) tweak Chebfun to work under Octave, for example, removing undocumented classdef features.  The final goal is to have at least basic Chebfun features working on Octave.  An additional goal would be making "pkg install chebfun.zip" work in Octave.
Chebfun makes extensive use of classdef classes, and is one of the largest Free Software projects to do so.  Unfortunately it currently only works in Matlab.  This project seeks to (1) improve Octave's classdef support and (2) tweak Chebfun to work under Octave, for example, removing undocumented classdef features.  The final goal is to have at least basic Chebfun features working on Octave.  An additional goal would be making "pkg install chebfun.zip" work in Octave.


This project is important for both technical reasons (to improve Octave's classdef support) and ethical reasons (to allow Chebfun to run without proprietary software).
The impact of this project is improving Octave and allowing Chebfun to be used without proprietary software.


* '''Required skills'''
* '''Required skills'''
: Octave m-file programming, C++, some familiarity with Approximation Theory (a branch of mathematics).
: Octave m-file programming, classdef programming, probably C++, some familiarity with Approximation Theory (a branch of mathematics).
* '''Difficulty'''
* '''Difficulty'''
: Medium to Hard (probably requires a deep dive into how Octave supports OO).
: Medium (fixing Octave classdef bugs likely harder and requires a deep dive into how Octave supports OOP).
* '''Potential mentors'''
* '''Potential mentors'''
: Colin B. Macdonald, [[User:KaKiLa|KaKiLa]], Mike Miller (?), Carnë Draug (?), someone from Chebfun team (?).
: Colin B. Macdonald, [[User:KaKiLa|KaKiLa]], Mike Miller (?), Carnë Draug (?), someone from Chebfun team (?).


How to get started: learn about Chebfun, browse Octave's bug list for classdef-related bugs, play with other classdef projects (Pytave, https://github.com/cbm755/octsympy/issues/545)
How to get started: learn about Chebfun, browse Octave's bug list for classdef-related bugs.
 
First steps: clone this Chebfun [https://github.com/cbm755/chebfun/tree/octave_dev octave_dev branch].  On that, "f = chebfun(@(x) sin(x), [-2 6])" should work with Octave 4.3.0+ and maybe even with 4.2.1.  Check that "f(pi)" and "g = f + 1" work.  A good first task would be to study [https://github.com/cbm755/chebfun/commit/e20b0ad2dc89cfe8e50ba461b864eff7d5bbef17 this commit], a workaround for "f.funs{1}" using "temp = f.funs; temp{1}".  "2*f" is failing, can you fix it, perhaps with this workaround?  Or can you make "f.funs{1}" work by changing something in "@chebfun/subsref.m"?


== Adding functionality to Forge packages ==
== Adding functionality to Forge packages ==


=== Neural Networks package: Convolutional Neural Networks ===
Convolutional Neural Networks (CNNs) have recently become the state-of-the-art for image recognition and are widely used for solving classification and regression problems and for [https://github.com/tensorflow/tensorflow/blob/master/tensorflow/examples/tutorials/deepdream/deepdream.ipynb image generation]. The goal of the project is to implement a [https://it.mathworks.com/help/nnet/convolutional-neural-networks.html Matlab compatible] CNN toolbox using Google's library [https://www.tensorflow.org/ TensorFlow], which has a Python and C++ interface. As execution environment for the training function, the user will be able to choose between single/multiple CPUs and GPUs.
* '''Required skills'''
: C, C++, Python, m-file scripting, familiarity with Machine Learning algorithms, basic knowledge of Makefiles, experience with parallel computing and distributed systems.
* '''Difficulty'''
: Difficult.
* '''Mentors'''
: [[User:Francesco Faccio|Francesco Faccio]], Ankit


=== EPA hydrology software suite ===
=== EPA hydrology software suite ===
Line 281: Line 264:
=== TISEAN package ===
=== TISEAN package ===


[http://www.mpipks-dresden.mpg.de/~tisean/Tisean_3.0.1/index.html TISEAN] is a suite of code for nonlinear time series analysis. It has been [http://wiki.octave.org/TISEAN_package partially re-implemented] as libre software. The objective is to integrate TISEAN as an Octave Forge package, as was done for the Control package.
[http://www.mpipks-dresden.mpg.de/~tisean/Tisean_3.0.1/index.html TISEAN] is a suite of code for nonlinear time series analysis. It has been [[TISEAN package | partially re-implemented]] as libre software. The objective is to integrate TISEAN as an Octave Forge package, as was done for the Control package.
[[TISEAN_package | A lot has been completed]] but [[TISEAN_package:Procedure | there is still work left to do]].
[[TISEAN_package | A lot has been completed]] but [[TISEAN_package:Procedure | there is still work left to do]].


Line 311: Line 294:
=== Interval package ===
=== Interval package ===


The [[Interval_package|interval package]] provides several arithmetic functions with accurate and guaranteed error bounds. Its development started in the end of 2014 and there is some fundamental functionality left to be implemented. See the [http://octave.sourceforge.net/interval/overview.html list of functions], basically any missing numeric Octave function could be implemented as an interval extension in the package. Potential projects:
The [[Interval_package|interval package]] provides several arithmetic functions with accurate and guaranteed error bounds. Its development started in the end of 2014 and there is some fundamental functionality left to be implemented. See the [https://octave.sourceforge.io/interval/overview.html list of functions], basically any missing numeric Octave function could be implemented as an interval extension in the package. Potential projects:
* Make the package support N-dimensional arrays, this requires less knowledge of interval arithmetic but can be a rather exhaustive job since it affects most function files in the package
* Implement missing algorithms (as m-files)-difficulty and whether knowledge in interval analysis is required depends on the particular function. Of course, you may use papers which present such algorithms.
* Implement missing algorithms (as m-files)—difficulty and whether knowledge in interval analysis is required depends on the particular function. Of course, you may use papers which present such algorithms.
* Improve existing algorithms (support more options for plotting, support more options for optimizers, increase accuracy, …)
* Improve existing algorithms (support more options for plotting, support more options for optimizers, increase accuracy, …)
* Integrate functions from VERSOFT [http://uivtx.cs.cas.cz/~rohn/matlab/] in the package (some work has already been done and current progress is tracked in [[Interval_package#VERSOFT]]). This basically involves conversion of the documentation into Texinfo format, use Octave coding guidelines [https://www.gnu.org/software/octave/doc/v4.0.0/Octave-Sources-_0028m_002dfiles_0029.html] and to make sure that any called functions are available in the interval package. VERSOFT is originally based on INTLAB, a proprietary Octave package. Some functions may be missing. Also, the interval package doesn't support complex numbers, so it might not be possible to migrate some functions.
* Integrate functions from VERSOFT [http://uivtx.cs.cas.cz/~rohn/matlab/] in the package (some work has already been done and current progress is tracked in [[Interval_package#VERSOFT]]). This basically involves conversion of the documentation into Texinfo format, use [[Contribution_guidelines#Coding_style|Octave coding guidelines]] and to make sure that any called functions are available in the interval package. VERSOFT is originally based on INTLAB [http://www.ti3.tu-harburg.de/rump/intlab/], a proprietary Octave/Matlab package. Some functions may be missing. Also, the interval package doesn't support complex numbers, so it might not be possible to migrate some functions.
* List more interesting use cases of interval arithmetic in the package's manual [https://octave.sourceforge.io/interval/package_doc/Examples.html]
* List more interesting use cases of interval arithmetic in the package's manual [https://octave.sourceforge.io/interval/package_doc/Examples.html]


Line 324: Line 306:
* '''Mentor and co-mentor'''
* '''Mentor and co-mentor'''
: [[User:oheim|Oliver Heimlich]], [[User:Siko1056|Kai T. Ohlhus]]
: [[User:oheim|Oliver Heimlich]], [[User:Siko1056|Kai T. Ohlhus]]
=== OCS ===
[[Ocs package | OCS]] is a circuit simulator for Octave. The objective of this project is to update the code to use modern features of Octave (e.g. classdef), fix open bugs, increase compatibility with SPICE and improve compatibility with other Octave packages (odepkg, control etc).
* [http://octave.sourceforge.net/ocs/overview.html Package help at source forge.]
* '''Required skills'''
: m-file scripting, C, C++, and FORTRAN API knowledge.
* '''Difficulty'''
: easy/medium
* '''Mentor'''
: Sebastian Schöps, Carlo de Falco


== Infrastructure ==
== Infrastructure ==
Line 381: Line 376:
: [[User:KaKiLa|KaKiLa]], Carnë Draug, Carlo de Falco, Sebastian Schöps
: [[User:KaKiLa|KaKiLa]], Carnë Draug, Carlo de Falco, Sebastian Schöps


=== Command line suggestion feature ===
=== SPQR Interface ===


Currently Octave has no mechanism for suggesting corrections to typographic errors on the command line. An autocomplete/suggestion function is provided (using the double-TAB shortcut), but recent discussions have indicated a desire for a more proactive measure to catch user error.  Potential applicants are referred to bug {{bug|46881}} regarding the usage of grey vs. gray.
Octave implements QR factorization for sparse matrices, but it does so with an older library.  This has caused fundamental issues, including segfaults as recorded here (https://savannah.gnu.org/bugs/?func=detailitem&item_id=51950). The goal of this project is to program an interface to the API for the SQPR library (http://faculty.cse.tamu.edu/davis/suitesparse.html). This is the same library that Matlab uses for this purpose.
 
Suggested improvements are:
* provide one or more suggested corrections to the user when a command line entry produces an error.
* recognition and suggested correction for apparent syntax errors
* function suggestion(s) when a 'close' match is found (close remains to be defined)
* multiple suggestions if more than one option seems likely, along with a user-friendly method of selecting the appropriate choice.
* user selectable option to disable and/or customize the suggestion behavior
* correct operation, or graceful degradation, whether Octave is run in GUI or command-line mode.  
 
As mentioned in the bug {{bug|46881}} discussion, this project has little-to-no relation to m-code compatibility. As such, emulation of the behavior of other software is not required, nor even necessarily desired. Octave is free to implement as simple or complex a solution to this feature request as is necessary to provide the best experience to the user. There may be tools, features, or code from other license-compatible projects that can be of use here, and the applicant would be encouraged to identify and leverage such resources as appropriate.  


* '''Minimum requirements'''
* '''Minimum requirements'''
: TBD
: Ability to read and write C++ code.
* '''Difficulty'''
: Easy to Medium.
* '''Mentor'''
: Undetermined
 
 
=== Octave code sharing ===
Recently, on the [[OctConf_2017]] a [https://rawgit.com/siko1056/Octconf2017/master/octconf2017-publish-ohlhus-slides.pdf talk] about uploading [https://www.gnu.org/software/octave/doc/interpreter/XREFpublish.html published Octave code] to a MediaWiki (like this one) as an easy way to share code was given. With the talk, a [https://github.com/siko1056/OctConf2017 repository] containing example code for the MediaWiki upload is given. This might continue the idea of an unfinished [[Agora]] code sharing website, but one is not restricted to fully stay with the proposed approach. Another, but more ambitious idea is for example [http://central.scipy.org/ Scipy Central] - a website for Scipy code sharing. Their [https://github.com/scipy/SciPyCentral Code] is released under a BSD license.
 
* '''Minimum requirements'''
: Ability to read and write Octave code, some familiarity with C++ ([https://curl.haxx.se libcurl]), web development (GET/POST/FORM data, cookies), and [https://www.mediawiki.org/wiki/MediaWiki MediaWiki].
* '''Difficulty'''
* '''Difficulty'''
: Medium.
: Medium.
* '''Mentor'''
* '''Mentor'''
: [[User:Siko1056|Kai T. Ohlhus]]
:  


== Image Analysis ==
== Image Analysis ==
Line 422: Line 395:
As part of GSoC 2013, the core functions for image IO, {{codeline|imwrite}} and {{codeline|imread}}, were extended to better support this type of images. Likewise, many functions in the image package, mostly morphology operators, were expanded to deal with this type of image. Since then, many other functions have been improved, sometimes completely rewritten, to abstract from the number of dimensions. In a certain way, supporting ND images is also related to choosing good algorithms since such large images tend to be quite large.
As part of GSoC 2013, the core functions for image IO, {{codeline|imwrite}} and {{codeline|imread}}, were extended to better support this type of images. Likewise, many functions in the image package, mostly morphology operators, were expanded to deal with this type of image. Since then, many other functions have been improved, sometimes completely rewritten, to abstract from the number of dimensions. In a certain way, supporting ND images is also related to choosing good algorithms since such large images tend to be quite large.


This project will continue on the previous work, and be mentored by the previous GSoC student and current image package maintainer. Planning the project requires selection of functions lacking ND support and identifying their dependencies. For example, supporting {{codeline|imclose}} and {{codeline|imopen}} was better implemented by supporting {{codeline|imerode}} and {{codeline|imdilate}} which then propagated ND support to all of its dependencies. These dependencies need to be discovered first since often they are not being used yet, and may even be missing function. This project can also be about implementing functions that have [http://wiki.octave.org/Image_package#Missing_functions not yet been implemented]. Also note that while some functions in the image package will accept ND images as input, they are actually not correctly implemented and will give incorrect results.
This project will continue on the previous work, and be mentored by the previous GSoC student and current image package maintainer. Planning the project requires selection of functions lacking ND support and identifying their dependencies. For example, supporting {{codeline|imclose}} and {{codeline|imopen}} was better implemented by supporting {{codeline|imerode}} and {{codeline|imdilate}} which then propagated ND support to all of its dependencies. These dependencies need to be discovered first since often they are not being used yet, and may even be missing function. This project can also be about implementing functions that have [[Image package#Missing functions | not yet been implemented]]. Also note that while some functions in the image package will accept ND images as input, they are actually not correctly implemented and will give incorrect results.


* '''Required skills'''
* '''Required skills'''
Line 455: Line 428:
: Carnë Draug
: Carnë Draug


== GUI ==
=== GUI Variable Editor and Property Inspector ===


Octave has a preliminary implementation of a Variable Editor: a spreadsheet-like tool for quickly editing and visualizing variables.  The initial phase of the project will be learning how the implementation was done.


With the knowledge gained, the second part of the project will be to implement a Property Inspector.  This is a spreadsheet like interface to the many, many graphics properties that exist and are different on a per-object basis.  The goal would be not only the concise-display of the existing properties, but a reasonable user interface to change them.  As examples, boolean properties should be able to be toggled with a double-click; Radio properties should have a drop-down list of only the supported options; Other properties that can be modified should have the constraints built-in (for example, Linewidth must be a scalar, while Position must be a 1x4 vector).  It would also be important to have easy access to the documentation of a property.


For reference, Matlab has a similar Property Inspector (https://www.mathworks.com/help/matlab/ref/inspect.html).


* '''Minimum requirements'''
: Ability to read and write C++ code.  Experience with Qt toolkit and GUI programming is optional, but desirable.
* '''Difficulty'''
: Medium.
* '''Mentor'''
:
== Graphics ==
=== PolarAxes and Plotting Improvements ===
Octave currently provides supports for polar axes by using a Cartesian 2-D axes and adding a significant number of properties and callback listerners to get things to work.  What is needed is a first class implementation of a "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" exist 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
* '''Minimum requirements'''
: Ability to read and write C++ code.  Ability to read and write Octave code.  Experience with OpenGL programming is optional.
* '''Difficulty'''
: Medium.
* '''Mentor'''
: Rik


<noinclude>
<noinclude>
Nir
281

edits

Retrieved from "https://wiki.octave.org/Special:MobileDiff/10596...11212"

Navigation menu