Summer of Code - Getting Started: Difference between revisions

Jump to navigation Jump to search

Summer of Code - Getting Started (edit)

Revision as of 09:03, 21 January 2021

312 bytes added ,  21 January 2021
m
no edit summary
(→‎TISEAN package: Improve description.)
mNo edit summary
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
Since 2011 the GNU Octave project has mentored 38 students in [[Summer of Code]] (SoC) programs by [https://summerofcode.withgoogle.com/ Google] and [https://socis.esa.int/ ESA].  Those programs aim to populate open-source software development and to attract potential new Octave developers.
Since 2011 the GNU Octave project has mentored 38 students in [[Summer of Code]] (SoC) programs by [https://summerofcode.withgoogle.com/ Google] and [https://socis.esa.int/ ESA].  Those programs aim to advertise open-source software development and to attract potential new Octave developers.


= Steps toward a successful application =
= Steps toward a successful application =
Line 7: Line 7:
#* We are interested in you as motivated developer 💻  There is no need to present an overwhelming CV with prestigious universities 🏰 and programming contest awards 🏆 in it.  We are very fine if you just communicate using a nickname with us.  
#* We are interested in you as motivated developer 💻  There is no need to present an overwhelming CV with prestigious universities 🏰 and programming contest awards 🏆 in it.  We are very fine if you just communicate using a nickname with us.  
#* If your first question is "Hi I'm new to Octave. What should I do?" '''you are out''' 🤦
#* If your first question is "Hi I'm new to Octave. What should I do?" '''you are out''' 🤦
#* Remember, '''we are mentors and not your boss 🙂'''
# 📝💡 '''Tell us what you are going to do.'''
# 📝💡 '''Tell us what you are going to do.'''
#* When you contact us for the first time, do not write just to say in what project you're interested in.  Be specific about what you are going to do, post many links 🔗, show us you know what you are talking about 💡, and ask many [http://www.catb.org/esr/faqs/smart-questions.html smart questions] 🤓
#* When you contact us for the first time, do not write just to say in what project you're interested in.  Be specific about what you are going to do, post many links 🔗, show us you know what you are talking about 💡, and ask many [http://www.catb.org/esr/faqs/smart-questions.html smart questions] 🤓
#* Remember, '''we are voluntary developers and not your boss''' 🙂
# 👩‍🔬 '''Get your hands dirty.'''
# 👩‍🔬 '''Get your hands dirty.'''
#* We are curious about your programming skills ⌨️
#* We are curious about your programming skills ⌨️
Line 55: Line 55:
== ode15{i,s} : Matlab Compatible DAE solvers ==
== ode15{i,s} : Matlab Compatible DAE solvers ==


An initial implementation of a Matlab compatible ode15{i,s} solver,
An initial implementation of Matlab compatible Differential Algebraic Equations (DAE) solvers, {{manual|ode15i}} and {{manual|ode15s}}, based on [https://computing.llnl.gov/projects/sundials SUNDIALS],  
based on [http://computation.llnl.gov/projects/sundials SUNDIALS],  
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 Francesco Faccio during GSOC 2016.
The blog describing the work is [http://gsoc2016ode15s.blogspot.it/ here].
The resulting code has been pushed into the main Octave repository in the development branch and
consists mainly of the following three files
[https://hg.savannah.gnu.org/hgweb/octave/file/tip/libinterp/dldfcn/__ode15__.cc __ode15__.cc],
[https://hg.savannah.gnu.org/hgweb/octave/file/tip/scripts/ode/ode15i.m ode15i.m] and
[https://hg.savannah.gnu.org/hgweb/octave/file/tip/scripts/ode/ode15s.m ode15s.m].
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]


Possible useful improvements that could be done in a new project include:
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.


* 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} work with datatypes other than double
* improve interpolation at intermediate time steps.
* general code profiling and optimization
Other tasks, not strictly connected to ode15{i,s} but closely related, that could be added
to a possible project plan would be improving documentation and tests in odepkg and removing
overlaps with the documentation in core Octave.
* '''Required skills'''
* '''Required skills'''
: Knowledge of Octave, C/C++; familiarity with numerical methods for DAEs
: Knowledge of Octave, C/C++; familiarity with numerical methods for DAEs
Line 119: Line 101:
* '''Potential mentors'''
* '''Potential mentors'''
: Rik  
: Rik  
== Table datatype ==
In 2013, Matlab introduced a [https://www.mathworks.com/help/matlab/tables.html new table datatype] to conveniently organize and access data in tabular form.  This datatype has not been introduced to Octave yet (see bug {{bug|44571}}).  However, there are two initial implementation approaches https://github.com/apjanke/octave-tablicious and https://github.com/gnu-octave/table.
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.
* '''Required skills'''
: Knowledge of Octave, C/C++
* '''Potential mentors'''
: [[User:siko1056|Kai]]


== Adding functionality to packages ==
== Adding functionality to packages ==
Line 144: Line 137:
=== TISEAN package ===
=== TISEAN package ===


The [[TISEAN package]] provides an Octave interface to [http://www.mpipks-dresden.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.
   
   
* '''Required skills'''
* '''Required skills'''
Retrieved from "https://wiki.octave.org/Special:MobileDiff/13592...13602"

Navigation menu