Jump to navigation Jump to search
→‎OCS: Add link to open bugs on Savannah.
The following is distilled from the [[Projects]] page for the benefit of potential [ Google] and [http 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.
== Help Us Get To Know You ==
*: If you aren't communicating with us before the application is due, your application will not be accepted.
*:* '''Join the [ maintainers mailing list]''' or read the archives and see what topics we discuss and how the developers interact with each other.
*:* '''Hang out in our [ IRC channel]'''. Ask questions, answer questions from users, show us that you are motivated, and well-prepared. There will be more applicants than we can effectively mentor, so do ask for feedback on your public application to increase the strength of your proposal!
*: 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 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 [ How to ask questions the smart way]:*:*: <blockquote cite="">''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.
*:* 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.
== 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).
*: Don't just tell us how interested you are, show us that you're willing and able to '''contribute''' to Octave. You can do that by [ fixing a few bugs] or [http submitting patches] well before the deadline, in addition to regularly interacting with Octave maintainers and users on the mailing list and IRC. Our experience shows us that successful SoC students demonstrate their interest early and often.
== Prepare Your Proposal With Us ==
*: By working with us to prepare your proposal, you'll be getting to know us and showing us how you approach problems. The best place for this is your Wiki user page and the [ IRC channel].
*: '''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]]
*:* [ Octave Manual on Installing Octave]
* '''The Version Control System'''
*: We use [ Mercurial] (abbreviated hg).
* '''The Procedure for Contributing Changesets'''
*: 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 [[Contribution guidelines | contribution]] [http 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.
* '''The Maintainers Mailing List'''
*: 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'''
*: [ 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'''
*: In addition, you probably should know '''some''' mathematics, engineering, experimental science, or something of the sort.
= Suggested projects =
The following projects are broadly grouped by category and probable skills required to tackle each. Remember to check [[Projects]] for more ideas if none of these suit you, and your own ideas are always welcome. You can also look at our [[Summer of Code|completed past projects page]] for more inspiration.
{{Note|these These are suggested projects but you are welcome to propose your own projects provided you find an Octave mentor}}
== Summary table ==
! <br />!! !! !! !! !! !!
| [[Summer_of_Code_Project_IdeasSummer of Code - Getting Started#ode15s_ode15.7Bi.2Cs.7D_:_Matlab_Compatible_DAE_solver _Matlab_Compatible_DAE_solvers | 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_IdeasSummer of Code - Getting Started#Improve_logm.2C_sqrtm.2C_funm | Improve logm, sqrtm, funm]] || ? || Marco Caliari, Mudit Sharma || Numerical || [ No] || Hard || Independent devs 2016
| [[Summer_of_Code_Project_IdeasSummer of Code - Getting Started#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_IdeasSummer of Code - Getting Started#EPA_hydrology_software_suite | EPA hydrology software suite]] || [[User:KaKiLa| KaKiLa]] || ? || Octave Forge || Yes || Medium || Never
| [[Summer_of_Code_Project_IdeasSummer of Code - Getting Started#FullSWOF overland flow simulator | FullSWOF overland flow simulator]] || [[User:KaKiLa| KaKiLa]] || ? || Octave Forge || Yes || Medium || Never
| [[Summer_of_Code_Project_IdeasSummer of Code - Getting Started#TISEAN_package | TISEAN: Nonlinear Time Series Analysis]] || [[User:KaKiLa|KaKiLa]] || ? || Octave Forge || [[TISEAN_package | No]] || Medium || GSoC 2015
| [[Summer_of_Code_Project_IdeasSummer of Code - Getting Started#Octave_Package_management | Octave Package management]] || Sebastian Schöps || [[User:KaKiLa|KaKiLa]], Carnë Draug, Carlo de Falco || Infrastructure || Yes || Medium || Never
| [[Summer_of_Code_Project_IdeasSummer of Code - Getting Started#Symbolic_package | Symbolic package]] || Colin B. Macdonald || Mike Miller, Abhinav Tripathi || Octave Forge || [ Octsympy] || Medium || GSoC 2016
| [[Summer_of_Code_Project_IdeasSummer of Code - Getting Started#Interval_package OCS | Interval OCS package]] || [[User:oheimSebastian Schöps |Oliver Heimlich]] || [[User:Siko1056|Kai T. Ohlhus]] Sebastian Schöps || Octave Forge, Numerical || No Yes || Medium Easy || [ GSoC 2017]Never
| [[Summer_of_Code_Project_IdeasSummer of Code - Getting Started#OCS Using_Python_within_Octave | OCS Pythonic package]] || Sebastian Schöps Mike Miller || Sebastian Schöps Colin B. Macdonald, Abhinav Tripathi || Octave Forge, Numerical Infrastructure || Yes No || Easy Medium || Neversome in GSoC 2016
| [[Summer_of_Code_Project_IdeasSummer of Code - Getting Started#Using_Python_within_Octave JSON_encoding.2Fdecoding | Pytave projectJSON encoding/decoding]] || Mike Miller [[User:Siko1056|Kai T. Ohlhus]] || Colin B. Macdonald, Abhinav Tripathi ? || Infrastructure || No Yes || Medium || some in GSoC 2016Never
| [[Summer_of_Code_Project_IdeasSummer of Code - Getting Started#Jupyter_Integration Jupyter_Notebook_Integration | Jupyter integrationNotebook Integration]] || Mike Miller || Colin B. Macdonald, Ankit Raj [[User:Siko1056|Kai T. Ohlhus]] || Infrastructure || Yes || Medium || Never
| [[Summer_of_Code_Project_IdeasSummer of Code - Getting Started#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 -| [[Summer_of_Code_Project_Ideas#SPQR Interface | Write API to SPQR Library]] || ? || || Infrastructure || Yes || Medium || Never|-| [[Summer_of_Code_Project_IdeasGetting Started#PolarAxes and Plotting Improvements | PolarAxes and Plotting Improvements ]] || ? || Rik || Graphics || Yes || Medium || Never
: Difficult.
* '''Potential mentors'''
: ?Marco Caliari, Mudit Sharma
=== Improve iterative methods for sparse linear systems ===
GNU Octave currently has the following Krylov subspace methods for sparse linear systems: pcg (spd matrices) and pcr (Hermitian matrices), bicg,
bicgstab, cgs, gmres, and qmr (general matrices). The description of some of them (pcr, qmr) and their error messages are not aligned. Moreover, they have similar blocks of code (input check for instance) which can be written once and for all in common functions. The first step in this project could be a revision and a synchronization of the codes, starting from the project [httphttps://planetsocis16octave-improveiterativemethods.octaveblogspot.orgcom/, SOCIS2016], whose latest patch, still to be included, which is [ here]already merged into Octave (cset {{cset|6266e321ef22}}).
In Matlab, some additional methods are available: minres and symmlq (symmetric matrices), bicgstabl (general matrices), lsqr (least
squares). The second step in this project could be the implementation of some of these missing functions.
The reference book is available [ herereference book by Yousef Saad]is available online.
* '''Required skills'''
: Maybe hard the mathematical part, medium the programming part.
* '''Mentor'''
:Marco Caliari, Carlo de Falco
=== Chebfun in Octave ===
[http / 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 "<code>pkg install" </code> work in Octave.
The impact of this project is improving Octave and allowing Chebfun to be used without proprietary software.
How to get started:
* Learn about [ Chebfun]
* Browse [ Octave's bug list] for "classdef"-related bugs.
* Clone this Chebfun [ octave_dev branch].
** On that, <code>f = chebfun(@(x) sin(x), [-2 6])</code> should work with Octave 4.3.0+ and maybe even with 4.2.1. Check that <code>f(pi)</code> and <code>g = f + 1</code> work.
** A good first task would be to study [ this commit], a workaround for <code>f.funs{1}</code> using <code>temp = f.funs; temp{1}</code>. <code>2*f</code> is failing, can you fix it, perhaps with this workaround? Or can you make <code>f.funs{1}</code> work by changing something in <code>@chebfun/subsref.m</code>?
* '''Required skills'''
* '''Potential mentors'''
: 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.
First steps: clone this Chebfun [ 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 [ 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 ==
Starting points
* [http The FullSWOF Project].
* [ FullSWOF: A software for overland flow simulation]
* [ Initial work on Bitbucket]
=== Symbolic package ===
Octave's [ Symbolic package] handles symbolic computing and other CAS tools. The main component of Symbolic is a pure m-file class "@sym" which uses the Python package [ 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. Recently, a GSoC2016 project successfully re-implemented this communication using the new [ Pytave tool[Pythonic|Pythonic package]].
This project proposes to go further: instead of using Pytave 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 Pytave 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 "f.diff(x)" instead of "diff(f, x)".
* '''Required skills'''
: OO-programming with m-files, Python, and possibly C/C++ for improving Pytave Pythonic (if needed).
* '''Difficulty'''
: easy/medium
* '''Mentors and/or other team members'''
: Colin B. Macdonald, Mike Miller, Abhinav Tripathi
=== 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 [ list of functions], basically any missing numeric Octave function could be implemented as an interval extension in the package. Potential projects:
* 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, …)
* Integrate functions from VERSOFT [] 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 [], 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 []
* '''Required skills'''
: m-file scripting, basic knowledge of computer arithmetics (especially floating-point computations), interval analysis (depending on the functions to implement).
* '''Difficulty'''
: Medium.
* '''Mentor and co-mentor'''
: [[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).
* [ Package help at source forge.]
== Infrastructure ==
=== JSON encoding/decoding === [ JavaScript Object Notation], in short JSON, is a very common human readable and structured data format. Unfortunately, GNU Octave still lacks of builtin support of that data format. Having JSON support, Octave can improve for example it's web service functions, which often exchange JSON data these days. Another interesting applicatoin is described in another Octave GSoC project, see [[Summer of Code - Getting Started#Jupyter_Integration | Jupyter integration]]. In bug {{bug|53100}} a vivid discussion about proper JSON support took place. As JSON is a highly demanded feature for Octave, there are already several attempts to fill the gap: * [ jsonlab] (M-file implementation, probably slow for large JSON files)* [ JSONio] (C MEX wrapper around [ jsmn])* [ octave-rapidjson] (C++ Octave wrapper around [ RapidJSON])* [ octave-jsonstuff] (C++ Octave wrapper around [ RapidJSON]) For different reasons, none of them can be directly merged into Octave core yet. Thus there is still lots of work to do. The goal of this project is to evaluate (and to cherry pick from) the implementations above, to create Matlab compatible [ jsonencode] and [ jsondecode] functions. This involves proper documentation of the work and unit tests to ensure the correctness of the implementation. * '''Minimum requirements''': Good Octave and C/C++ programming knowledge. Ability to make use of C/C++ libraries.* '''Difficulty''': Medium.* '''Mentor''': [[User:Siko1056|Kai T. Ohlhus]] === Jupyter Notebook Integration ===
[ Jupyter Notebook] is a web-based worksheet interface for computing. There is a [ Octave kernel for Jupyter]. This project seeks in first place to improve that kernel to make Octave a first-class experience within the Jupyter Notebook.
In general the [ Jupyter Notebook Format] is a plain JSON document. In combination with another Octave GSoC project (see [[Summer of Code - Getting Started#JSON_encoding.2Fdecoding | JSON encoding/decoding]]), a second valuable outcome was that Octave can run (and fill) those Jupyter Notebooks on it's own. This would enable Jupyter Notebook users to evaluate long running Octave Notebooks on a computing server without permanent browser connection, which is [ still a pending issue].
* '''Minimum requirements'''
: Good Octave and Python programming knowledge.
* '''Difficulty'''
: Medium.
* '''Mentors'''
: Colin B. Macdonald, Mike Miller, others?[[User:Siko1056|Kai T. Ohlhus]]
=== Using Python within Octave ===
[ Pytave[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. Ideally, Pytave will Pythonic may eventually not be a separate projectpackage, but rather a core feature of Octave. This project aims to improve Pytave Pythonic with the goal of merging making the code into the core Octave code basepackage more stable, maintainable, and full-featured.
Based on a previous summer project related to PytavePythonic, this work will consist of fast-paced collaborative software development based on tackling the [https://bitbucketgitlab.orgcom/mtmiller/pytaveoctave-pythonic/issues?status=new&status=open pytave 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 decision 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?
* '''Mentors'''
* '''Mentor'''
: [[User:KaKiLa|KaKiLa]], Carnë Draug, Carlo de Falco, Sebastian Schöps
=== SPQR Interface ===
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 ( The goal of this project is to program an interface to the API for the SQPR library ( This is the same library that Matlab uses for this purpose.
* '''Minimum requirements'''
: Ability to read and write C++ code.
* '''Difficulty'''
: Medium.
* '''Mentor'''
== Image Analysis ==
* '''Potential mentor'''
: 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 (
* '''Minimum requirements'''
: Ability to read and write C++ code. Experience with Qt toolkit and GUI programming is optional, but desirable.
* '''Difficulty'''
: Medium.
* '''Mentor'''
== Graphics ==

Navigation menu