|
|
| (197 intermediate revisions by 25 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.
| | {{Note|GNU Octave is a [https://summerofcode.withgoogle.com/programs/2024/organizations/gnu-octave mentoring organization for GSoC 2024].}} |
|
| |
|
| = Steps Toward a Successful Application =
| | Since 2011 the GNU Octave project has successfully mentored: |
| | * [[Summer of Code | '''42 participants''' 🙂]] |
| | * [[Summer of Code | '''44 projects''' 📝]] |
| | in [[Summer of Code]] (SoC) programs by [https://summerofcode.withgoogle.com/ Google] and [https://esa.int/ ESA]. |
|
| |
|
| == Help Us Get To Know You ==
| | Those SoC programs aim to advertise open-source software development and to attract potential new Octave developers. |
| *: If you aren't communicating with us before the application is due, your application will not be accepted.
| |
| *:* '''Join the [https://lists.gnu.org/mailman/listinfo/octave-maintainers 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 [https://webchat.freenode.net/?channels=#octave 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!
| |
| * '''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.
| |
| *:* 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".
| |
| *:* 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>
| |
| *:* 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.
| |
| *:* Take a look at the [[Short projects]] for something that may be simple to start with.
| |
| == 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 [https://savannah.gnu.org/bugs/?group=octave fixing a few bugs] or [http://savannah.gnu.org/patch/?group=octave 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 [https://webchat.freenode.net/?channels=#octave IRC channel].
| |
| == Complete Your Application ==
| |
| *: Fill out our '''''public''''' application template.
| |
| *:* This is best done by '''[[Special:CreateAccount|creating an account at this wiki]]''', and copying the '''[[Template:Student_application_template_public|template]]''' from its page.
| |
| *:* You really only need to copy and answer the '''''public''''' part there, there is no need to showcase everything else to everybody reading your user page!
| |
| *: Fill out our '''''private''''' application template.
| |
| *:* This is best done by copying the '''[[Template:Student_application_template_private|template]]''' from its page and '''adding the required information to your application at Google (melange)''' or at '''ESA'''.<br>
| |
| *:* Only the organization admin and the possible mentors will see this data. You can still edit it after submitting until the deadline!
| |
|
| |
|
| == Things You'll be Expected to Know or Quickly Learn On Your Own == | | = Steps toward a successful application = |
|
| |
|
| Octave is mostly written in C++ and its own scripting language that is mostly compatible with Matlab. There are bits and pieces of Fortran, Perl, C, awk, and Unix shell scripts here and there. In addition to being familiar with C++ and Octave's scripting language, successful applicants will be familiar with or able to quickly learn about Octave's infrastructure. You can't spend the whole summer learning how to build Octave or prepare a changeset and still successfully complete your project. | | # 😉💬 '''We want to get to know you (before the deadline). Communicate with us.''' |
| | #* Join [https://octave.discourse.group/ '''Octave Discourse'''] or [[IRC]] for general discussion and to ask questions (Please do not use the bug tracker for general GSOC inquiries unrelated to specific bugs found with Octave.) Using a nickname is fine. |
| | #* Show us that you're motivated to work on Octave 💻. There is no need to present an overwhelming CV 🏆; evidence of involvement with Octave is more important. |
| | #* '''<span style="color:darkblue;">If you never talked to us, we will likely reject your proposal</span>''', even it looks good 🚮 |
| | # 👩🔬 '''Get your hands dirty.''' |
| | #* We are curious about your programming skills 🚀 |
| | #** Your application will be much stronger if you [https://savannah.gnu.org/bugs/?group=octave fix Octave bugs] or [https://savannah.gnu.org/patch/?group=octave submit patches] before or during the application period. |
| | #** You can take a look at the [[short projects]] for some simple bugs to start with. |
| | #* '''Use Octave!''' |
| | #** If you come across something that does not work the way you like ➡️ try to fix that 🔧 |
| | #** Or if you find a missing function ➡️ try to implement it. |
| | # 📝💡 '''Tell us what you are going to do.''' |
| | #* Do not write just to say what project you're interested in. Be specific about what you are going to do, include 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 volunteer developers and not your boss''' 🙂 |
| | # 📔 '''Prepare your proposal with us.''' |
| | #* Try to show us as early as possible a draft of your proposal 📑 |
| | #* If we see your proposal for the first time after the application deadline, it might easily contain some paragraphs not fully clear to us. Ongoing interaction will give us more confidence that you are capable of working on your project 🙂👍 |
| | #* Here’s a sample proposal outline that you can use as a reference when drafting your own application. [https://docs.google.com/document/d/1kGtT9_f0FrXdCKwyKEWwOV6R-AU90bkd/edit?usp=sharing&ouid=115736651221450989198&rtpof=true&sd=true Sample Proposal] |
| | #* Then submit the proposal following the applicable rules, e.g. for [https://google.github.io/gsocguides/student/writing-a-proposal GSoC]. 📨 |
|
| |
|
| * '''The Build System'''
| | = How do we judge your application? = |
| *: [http://en.wikipedia.org/wiki/GNU_build_system The GNU build system] is used 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.
| |
| *: '''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.
| |
| *:* [[Building_for_Linux_systems]]
| |
| *:* [[Building]]
| |
| *:* [https://www.gnu.org/software/octave/doc/interpreter/Building-the-Development-Sources.html Octave Manual on Building the Development Sources]
| |
| *:* [https://www.gnu.org/software/octave/doc/interpreter/Installation.html Octave Manual on Installing Octave]
| |
| * '''The Version Control System'''
| |
| *: We use [http://mercurial.selenic.com/ 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.
| |
| * '''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 [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.
| |
| *: [[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'''
| |
| *: We primarily use [https://lists.gnu.org/mailman/listinfo/octave-maintainers mailing lists] for communication among developers.
| |
| *: The mailing list is used most often for discussions about non-trivial changes to Octave, or for setting the direction of development.
| |
| *: You should follow basic mailing list etiquette. For us, this mostly means "do not [https://en.wikipedia.org/wiki/Posting_style#Top-posting top post]".
| |
| * '''The IRC Channel'''
| |
| *: We also have [http://webchat.freenode.net?channels=octave the #octave IRC channel in Freenode].
| |
| *: You should be familiar with the IRC channel. It's very helpful for new contributors (you) to get immediate feedback on ideas and code.
| |
| *: 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'''
| |
| *: [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.
| |
| * '''Related Skills'''
| |
| *: In addition, you probably should know '''some''' mathematics, engineering, experimental science, or something of the sort.
| |
| *: If so, you probably have already been exposed to the kinds of problems that Octave is used for.
| |
|
| |
|
| == Criteria by which applications are judged ==
| | Depending on the mentors and SoC program there are varieties, but typically the main factors considered would be: |
|
| |
|
| These might vary somewhat depending on the mentors and coordinators for a particular Summer of Code, but typically the main factors considered would be:
| | * '''You have demonstrated interest in Octave and an ability to make substantial modifications to Octave''' |
| | *: The most important thing is that you've contributed some interesting code samples to judge your skills. It's OK during the application period to ask for help on how to format these code samples, which normally are Mercurial patches. |
|
| |
|
| * '''Applicant has demonstrated an ability to make substantial modifications to Octave''' | | * '''You showed understanding of your topic''' |
| *: The most important thing is that you've contributed some interesting code samples to judge you by. It's OK during the application period to ask for help on how to format these code samples, which normally are Mercurial patches.
| | *: Your proposal should make it clear that you're reasonably well versed in the subject area and won't need all summer just to read up on it. |
| | |
| * '''Applicant shows understanding of topic'''
| |
| *: Your application should make it clear that you're reasonably well versed in the subject area and won't need all summer just to read up on it. | |
| | |
| * '''Applicant shows understanding of and interest in Octave development'''
| |
| *: The best evidence for this is previous contributions and interactions.
| |
|
| |
|
| * '''Well thought out, adequately detailed, realistic project plan''' | | * '''Well thought out, adequately detailed, realistic project plan''' |
| *: "I'm good at this, so trust me" isn't enough. You should describe which algorithms you'll use and how you'll integrate with existing Octave code. You should also prepare a full timeline and goals for the midterm and final evaluations. | | *: "I'm good at this, so trust me" isn't enough. In your proposal, you should describe which algorithms you'll use and how you'll integrate with existing Octave code. You should also prepare a project timeline and goals for the midterm and final evaluations. |
|
| |
|
| = Suggested projects = | | = What you should know about Octave = |
|
| |
|
| 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.
| | GNU Octave is mostly written in C++ and its own scripting language that is mostly compatible with Matlab. There are bits and pieces of Fortran, Perl, C, awk, and Unix shell scripts here and there. In addition to being familiar with C++ and Octave's scripting language, you as successful applicant will be familiar with or able to quickly learn about Octave's infrastructure. You can't spend the whole summer learning how to build Octave or prepare a changeset and still successfully complete your project 😇 |
|
| |
|
| {{Note|these are suggested projects but you are welcome to propose your own projects provided you find an Octave mentor}}
| | You should know: |
| | # How to build Octave from its source code using [http://en.wikipedia.org/wiki/GNU_build_system the GNU build system]. |
| | #* Read in this wiki: [[Developer FAQ]], [[Building]] |
| | #* Tools to know: [https://en.wikipedia.org/wiki/GNU_Compiler_Collection gcc], [https://en.wikipedia.org/wiki/Make_(software) make] |
| | # How to submit patches (changesets). |
| | #* Read in this wiki: [[Contribution guidelines]], [[Mercurial]] |
| | #* Tools to know: [https://en.wikipedia.org/wiki/Mercurial Mercurial (hg)], [https://en.wikipedia.org/wiki/Git git] |
|
| |
|
| == Summary table == | | = Suggested projects = |
|
| |
|
| {| class="wikitable sortable" style="text-align: center; width:99%"
| | The following suggested projects are distilled from the [[Projects]] page for the benefit of potential SoC participants. You can also look at our [[Summer of Code|completed past projects]], or the current [https://hg.savannah.gnu.org/hgweb/octave/file/tip/etc/ROADMAP.md | Octave Development Roadmap] for more inspiration. |
| |-
| |
| !Title
| |
| !Mentor
| |
| !co-Mentors
| |
| !Class
| |
| !New?
| |
| !Difficulty
| |
| !Last active
| |
| |-
| |
| ! <br />!! !! !! !! !! !!
| |
| |-
| |
| | [[Summer_of_Code_Project_Ideas#Make_specfuns_special_again | Make specfuns special again]] || Marco Caliari || Colin Macdonald || Numerical || Yes || Medium || Never
| |
| |-
| |
| | [[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#Improve_logm.2C_sqrtm.2C_funm | Improve logm, sqrtm, funm]] || Jordi Gutiérrez Hermoso || Marco Caliari, Mudit Sharma || Numerical || [https://github.com/RickOne16/matrix No] || Hard || Independent devs 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#EPA_hydrology_software_suite | EPA hydrology software suite]] || [[User:KaKiLa| KaKiLa]] || ? || Octave Forge || Yes || Medium || Never
| |
| |-
| |
| | [[Summer_of_Code_Project_Ideas#TISEAN_package | TISEAN: Nonlinear Time Series Analysis]] || [[User:KaKiLa|KaKiLa]] || ? || Octave Forge || [[TISEAN_package | No]] || Medium || GSoC 2015
| |
| |-
| |
| | [[Summer_of_Code_Project_Ideas#Mapping_or_Geometry_package:_Implement_boolean_operations_on_polygons | Geometry: Boolean operations on Polygons]] || John Swensen || [[User:KaKiLa|KaKiLa]], Philip Neuhuis || Octave Forge || [https://amrkeleg.wordpress.com/ No] || Easy || GSoC 2016
| |
| |-
| |
| | [[Summer_of_Code_Project_Ideas#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_Ideas#Symbolic_package | Symbolic package]] || Colin B. Macdonald || Mike Miller, Abhinav Tripathi || Octave Forge || [https://github.com/cbm755/octsympy Octsympy] || Medium || GSoC 2016
| |
| |-
| |
| | [[Summer_of_Code_Project_Ideas#Interval_package | Interval package]] || [[User:oheim|Oliver Heimlich]] || [[User:Siko1056|Kai T. Ohlhus]] || Octave Forge, Numerical || Yes || Medium || 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#Jupyter_Integration | Jupyter integration]] || Mike Miller || Colin B. Macdonald || Infrastructure || 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
| |
| |}
| |
|
| |
|
| == Numerical ==
| | {{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. Please note that for such a proposal to be successful it will almost certainly involve initiating pre-proposal discussion over at the [https://octave.discourse.group Octave Discourse forum].}} |
|
| |
|
| These projects involve implementing certain mathematical functions, primarily in core Octave.
| | == Adding more Classification classes and implementing missing methods in statistics package == |
|
| |
|
| === Make specfuns special again ===
| | Although a ClassificationKNN class was added in the latest statistics release (1.6.1), it still lacks several methods (only `predict` is available at the moment). This GSoC project aims at implementing more methods, such as crossval, cvloss, lime, loss, margin, partialDependence, plotPartialDependence, etc., as well as adding more classdefs related to classification classes, such as ClassificationGAM, ClassificationDiscriminant, ClassificationSVM, ClassificationNeuralNetwork, ClassificationNaiveBayes, etc. The statistics package, although heavily developed during the past years, still lacks a lot of classdef functionality. The scope is to implement classification classdef objects and their relevant methods in a MATLAB-compatible way. |
| | |
| 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.
| |
|
| |
|
| | * '''Project size''' [[#Project sizes | [?]]] and '''Difficulty''' |
| | : ~350 hours (hard) |
| * '''Required skills''' | | * '''Required skills''' |
| : Octave m-file programming, some familiarity with Approximation Theory (a branch of mathematics). | | : Octave, classdef, good knowledge of statistical methods |
| * '''Difficulty'''
| |
| : Medium (mathematics needed, but on the other hand, perhaps little or no C++).
| |
| * '''Potential mentors''' | | * '''Potential mentors''' |
| : Marco Caliari, Colin Macdonald, others? | | : [https://octave.discourse.group/u/pr0m1th3as Andreas Bertsatos] |
| | |
| 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 ===
| |
|
| |
|
| An initial implementation of a Matlab compatible ode15{i,s} solver,
| | == Custom re-implementation of the texi2html (v.1.82) command line tool == |
| based on [http://computation.llnl.gov/projects/sundials SUNDIALS],
| |
| 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
| |
| [http://hg.savannah.gnu.org/hgweb/octave/file/4890b1c4a6bd/libinterp/dldfcn/__ode15__.cc __ode15__.cc],
| |
| [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].
| |
| The list of outsanding 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:
| | Implement a compiled .oct function to relax the dependency of the pkg-octave-doc package on texi2html (v.1.82) command line tool, which is no longer maintained or further developed but also not readily available to all linux distributions. The idea is to have a `texi2html` function within the pkg-octave-doc package that will replace the functionality of the texi2html (v.1.82) command line tool. This will also help improve the speed of pkg-octave-doc processing large packages, which contain specific tags (such as @math) which are currently handled within Octave code. |
|
| |
|
| * 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] | | * '''Project size''' [[#Project sizes | [?]]] and '''Difficulty''' |
| | | : ~350 hours (hard) |
| * make ode15{i,s} 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''' |
| : C++; C; familiarity with numerical methods for DAEs; Basic knowledge of makefiles and/or autotools. | | : Perl, C++, Octave, Texinfo, HTML |
| * '''Difficulty'''
| |
| : Medium.
| |
| * '''Potential mentors''' | | * '''Potential mentors''' |
| : Francesco Faccio, Carlo de Falco, Marco Caliari, Jacopo Corno, Sebastian Schöps | | : [https://octave.discourse.group/u/pr0m1th3as Andreas Bertsatos] |
|
| |
|
| === Improve logm, sqrtm, funm ===
| |
|
| |
|
| The goal here is to implement some missing Matlab functions related to matrix functions like the [http://en.wikipedia.org/wiki/Matrix_exponential matrix exponential]. There is [http://octave.1599824.n4.nabble.com/matrix-functions-td3137935.html a general discussion] of the problem. A good starting point for available algorithms and open-source implementations is Higham and Deadman's [http://eprints.ma.man.ac.uk/2102/01/covered/MIMS_ep2014_8.pdf "A Catalogue of Software for Matrix Functions"].
| | == Port Chebfun to Octave and improve classdef support == |
|
| |
|
| | [https://www.chebfun.org| Chebfun] uses interpolation to approximate functions to very high accuracy, giving numerical computing that feels like symbolic computing. |
| | The software is implemented as collection of "classdef" classes and is Free and Open Source Software. |
| | However, Chebfun does not yet work with Octave, largely due to differences and issues with Octave's classdef implementation. |
| | This project has two aims: (1) make changes to the Chebfun code to make it work on Octave and (2) improve Octave's classdef functionality. |
| | Some initial steps toward to first goal can be found on [https://github.com/cbm755/chebfun/tree/octave_dev| this octave_dev branch]. |
| | The second goal will likely involve a collaborative effort because classdef is a priority on [https://hg.savannah.gnu.org/hgweb/octave/file/tip/etc/ROADMAP.md | Octave's Development Roadmap] and because other proposed projects also involve classdef. |
| | |
| | * '''Project size''' [[#Project sizes | [?]]] and '''Difficulty''' |
| | : ~350 hours (hard) |
| * '''Required skills''' | | * '''Required skills''' |
| : Read and Write both C++ and Octave code, find and read research papers, research experience in numerical analysis, familiarity with analysis of algorithms. | | : Octave, object-oriented programming, polynomial interpolation and approximation theory, C++. |
| * '''Difficulty'''
| |
| : Difficult.
| |
| * '''Potential mentors''' | | * '''Potential mentors''' |
| : Jordi Gutiérrez Hermoso | | : [https://octave.discourse.group/u/cbm Colin B. Macdonald] |
|
| |
|
| === 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 [http://planet.octave.org/#tag:blogger.com,1999:blog-1297699247151766814.post-8054019978706480250 SOCIS2016], whose latest patch, still to be included, is [https://savannah.gnu.org/patch/?9108 here].
| | == ode15{i,s} : Matlab Compatible DAE solvers == |
|
| |
|
| In Matlab, some additional methods are available: minres and symmlq (symmetric matrices), bicgstabl (general matrices), lsqr (least
| | 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], |
| squares). The second step in this project could be the implementation of some of these missing functions.
| | 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 reference book is available [www-users.cs.umn.edu/~saad/IterMethBook_2ndEd.pdf here] | | 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''' |
| | : ~350 hours (medium) |
| * '''Required skills''' | | * '''Required skills''' |
| : numerical linear algebra, m-file programming. | | : Octave, C/C++; familiarity with numerical methods for DAEs |
| * '''Difficulty''' | | * '''Potential mentors''' |
| : Maybe hard the mathematical part, medium the programming part. | | : 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] |
| * '''Mentor'''
| | --> |
| : Marco Caliari | |
|
| |
|
| === Chebfun in Octave === | | <!-- |
| | == PolarAxes and Plotting Improvements == |
|
| |
|
| [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.
| | Octave currently provides support 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}}. |
| | |
| 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). | |
|
| |
|
| | * '''Project size''' [[#Project sizes | [?]]] and '''Difficulty''' |
| | : ~350 hours (medium) |
| * '''Required skills''' | | * '''Required skills''' |
| : Octave m-file programming, C++, some familiarity with Approximation Theory (a branch of mathematics). | | : Octave, C/C++; optional experience with OpenGL programming |
| * '''Difficulty'''
| |
| : Medium to Hard (probably requires a deep dive into how Octave supports OO).
| |
| * '''Potential mentors''' | | * '''Potential mentors''' |
| : Colin B. Macdonald, [[User:KaKiLa|KaKiLa]], Marco Caliari (?), Mike Miller (?), Carnë Draug (?), someone from Chebfun team (?). | | : [https://octave.discourse.group/u/rik Rik] |
| | --> |
|
| |
|
| 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)
| | <!-- |
| | == Table datatype == |
|
| |
|
| == Adding functionality to Forge packages ==
| | 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. |
|
| |
|
| === Neural Networks package: Convolutional Neural Networks ===
| | 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. |
| 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 generating images]. 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.
| |
|
| |
|
| | * '''Project size''' [[#Project sizes | [?]]] and '''Difficulty''' |
| | : ~350 hours (hard) |
| * '''Required skills''' | | * '''Required skills''' |
| : C, C++, Python, m-file scripting, familiarity with Machine Learning algorithms, basic knowledge of Makefiles. | | : Octave, C/C++ |
| * '''Difficulty''' | | * '''Potential mentors''' |
| : Difficult. | | : ??? |
| * '''Mentor'''
| | --> |
| : [[User:Francesco Faccio|Francesco Faccio]]
| |
|
| |
|
| === EPA hydrology software suite === | | <!-- |
| Create native interfaces to the EPA software suites.
| | == TISEAN package == |
|
| |
|
| Starting points
| | 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. |
| * [https://forja.cica.es/projects/epanet-octave/ epanet-octave].
| |
| * [https://github.com/OpenWaterAnalytics/ Open Water Analytics]
| |
|
| |
|
| ==== SWMM ====
| | * '''Project size''' [[#Project sizes | [?]]] and '''Difficulty''' |
| ** [https://www.epa.gov/water-research/storm-water-management-model-swmm Official page]
| | : ~350 hours (medium) |
| ** Check work done in [https://github.com/water-systems/MatSWMM MatSWMM] [http://digital.csic.es/bitstream/10261/132982/1/MatSWMM.pdf article] | | * '''Required skills''' |
| | | : Octave, C/C++; FORTRAN API knowledge |
| ====EPANET====
| | * '''Potential mentors''' |
| ** [https://www.epa.gov/water-research/epanet Official page]
| | : [https://octave.discourse.group/u/kakila KaKiLa] |
| | | --> |
| ====Required skills====
| |
| : m-file scripting, C, C++, API knowledge, file I/O, classdef (optional).
| |
|
| |
|
| ====Difficulty==== | | <!-- |
| : easy/medium
| | == Better tab completion == |
|
| |
|
| ====Mentor====
| | 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] |
| : [[User:KaKiLa|KaKiLa]] | |
|
| |
|
| === TISEAN package ===
| | 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. |
|
| |
|
| [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.
| | Project: Improve tab completion. For example, |
| [[TISEAN_package | A lot has been completed]] 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. Do check [[TISEAN_package:Procedure#Table_of_functions|the progress of the project]] to see if you are interested.
| | * Typing |
|
| | : load x |
| * [http://octave.sourceforge.net/tisean/overview.html Package help at source forge.]
| | and then pressing tab should ideally give all loadable files and directories starting with x, not unrelated results like variables or functions. |
| * [https://sourceforge.net/p/octave/tisean/ci/default/tree/ Package repository at source forge.]
| |
|
| |
|
| * '''Required skills''' | | * Typing |
| : m-file scripting, C, C++, and FORTRAN API knowledge. | | :cd |
| * '''Difficulty'''
| | and tab should only give directories. |
| : easy/medium
| |
| * '''Mentor'''
| |
| : [[User:KaKiLa|KaKiLa]]
| |
|
| |
|
| === Symbolic package ===
| | * 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. |
|
| |
|
| Octave's [https://github.com/cbm755/octsympy 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 [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. Recently, a GSoC2016 project successfully re-implemented this communication using the new [https://bitbucket.org/mtmiller/pytave Pytave tool].
| | * 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. |
|
| |
|
| This project proposes to go further: instead of using Pytave 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 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)".
| | 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. |
|
| |
|
| | * '''Project size''' [[#Project sizes | [?]]] and '''Difficulty''' |
| | : ~350 hours (medium) |
| * '''Required skills''' | | * '''Required skills''' |
| : OO-programming with m-files, Python, and possibly C/C++ for improving Pytave (if needed). | | : ??? |
| * '''Difficulty''' | | * '''Potential mentors''' |
| : easy/medium | | : ??? |
| * '''Mentors and/or other team members'''
| | --> |
| : Colin B. Macdonald, Mike Miller, Abhinav Tripathi
| |
|
| |
|
| === Interval package === | | <!-- |
| | == Graphics rendering back to front sorting == |
|
| |
|
| 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:
| | 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. |
| * 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.
| |
| * 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.
| |
| * List more interesting use cases of interval arithmetic in the package's manual [https://octave.sourceforge.io/interval/package_doc/Examples.html]
| |
|
| |
|
| | * '''Project size''' [[#Project sizes | [?]]] and '''Difficulty''' |
| | : ~350 hours (medium) |
| * '''Required skills''' | | * '''Required skills''' |
| : m-file scripting, basic knowledge of computer arithmetics (especially floating-point computations), interval analysis (depending on the functions to implement). | | : ??? |
| * '''Difficulty''' | | * '''Potential mentors''' |
| : Medium. | | : ??? |
| * '''Mentor and co-mentor'''
| | --> |
| : [[User:oheim|Oliver Heimlich]], [[User:Siko1056|Kai T. Ohlhus]]
| |
|
| |
|
| === Mapping or Geometry package: Implement boolean operations on polygons === | | <!-- |
| | == Symbolic package == |
|
| |
|
| The goal is to implement a Matlab-compatible set of boolean operations and supporting function for acting on polygons. These include the standard set of potential operations such as union/OR, intersection/AND, difference/subtraction, and exclusiveor/XOR. | | The [[Symbolic package]] provides symbolic computing and other [https://en.wikipedia.org/wiki/Computer_algebra_system computer algebra system] tools via the [https://sympy.org SymPy Python library]. GSoC projects in 2016 and 2022 improved the package. |
| There is already an octave-forge package that implements a large part of this (the [http://octave.sourceforge.net/octclip/index.html octclip package]); however that does not do XOR; processing polygons with holes could be done better; and maintainability is hampered because all code comments etc. are in Spanish. Other than that, octclip performs fine.
| |
|
| |
|
| There are a variety of existing polygon libraries that implement much of the functionality and thus this would be incorporating the library into GNU Octave. The libraries with acceptable licenses are [http://www.angusj.com/delphi/clipper.php ClipperLib], [http://www.boost.org/doc/libs/1_60_0/libs/polygon/doc/index.htm Boost::Polygon], [https://github.com/boostorg/geometry Boost::Geometry], or [http://boolean.klaasholwerda.nl/bool.html kbool]. This would include implementing the following functions: polybool, ispolycw, poly2ccw, poly2cw, poly2fv, polyjoin, and polysplit. A partial implementation with ClipperLib and GPC can be found [https://sites.google.com/site/ulfgri/numerical/polybool here]. | | There are no specific plans for Symbolic in GSoC 2023, but improvements elsewhere that would help Symbolic include: |
| | * Developing the Octave-Pythonic package. |
| | * Fix the storage of non-expressions by working with upstream SymPy: currently we rely on deprecated functionality in SymPy. |
| | * Improvements and fixes to classdef-related issues in Octave itself. |
| | * Developing the Octave Jupyter kernel. |
|
| |
|
| | * '''Project size''' [[#Project sizes | [?]]] and '''Difficulty''' |
| | : ~350 hours (medium) |
| * '''Required skills''' | | * '''Required skills''' |
| : Knowledge of C++; C; familiarity with boolean logic; polygons, windings, and geometry | | : ??? |
| * '''Difficulty'''
| | * '''Potential mentors''' |
| : Easy to Medium.
| | : ??? |
| * '''Potential mentor''' | | --> |
| : John Swensen | |
| : [[User:KaKiLa|KaKiLa]]
| |
| | |
| == Infrastructure ==
| |
| | |
| === Jupyter Integration ===
| |
| | |
| [http://jupyter.org Jupyter Notebook] is a web-based worksheet interface for computing. There is a [https://github.com/Calysto/octave_kernel Octave kernel for Jupyter]. This project seeks to improve that kernel to make Octave a first-class experience within the Jupyter Notebook.
| |
| | |
| * '''Mentors'''
| |
| : Colin B. Macdonald, Mike Miller, others?
| |
|
| |
|
| | = Project sizes = |
|
| |
|
| === Using Python within Octave ===
| | As of 2024, possible project sizes are 90 (small), 175 (medium), or 350 hours (large) <ref>https://developers.google.com/open-source/gsoc/faq#how_much_time_does_gsoc_participation_take</ref>. |
| | |
| [https://bitbucket.org/mtmiller/pytave Pytave] 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 not be a separate project, but rather a core feature of Octave. This project aims to improve Pytave with the goal of merging the code into the core Octave code base.
| |
| | |
| Based on a previous summer project related to Pytave, this work will consist of fast-paced collaborative software development based on tackling the [https://bitbucket.org/mtmiller/pytave/issues?status=new&status=open pytave 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'''
| |
| : Mike Miller, Colin B. Macdonald, Abhinav Tripathi, others?
| |
| | |
| | |
| === Octave Package management ===
| |
| | |
| Octave management of installed packages is performed by a single function, {{codeline|pkg}}, which does pretty much everything. This function has a few limitations which are hard to implement with the current codebase, and will most likely require a full rewrite.
| |
| | |
| The planned improvements are:
| |
| | |
| * install from URLs
| |
| * install and update from repositories (hg and git)
| |
| * automatic handling of dependencies
| |
| * easily load, update or check specific package versions
| |
| * management of tests and demos in C++ sources of packages
| |
| * more flexibility on dependencies, e.g., dependent on specific Octave build options or being dependent in one of multiple packages
| |
| * support for multiple version packages
| |
| * support for multiple Octave installs
| |
| * support for system-wide and user installed packages
| |
| | |
| The main objective of this project is to make {{codeline|pkg}} more user friendly and to make it a tool to foster third party participation in Octave.
| |
| {{codeline|pkg}} needs to be more flexible and intelligent when dealing with packages, different verisons and different sources, as well as options on how to build and install the package.
| |
| There are also advance features of pkg that are useful for testing packages. However, the current {{codeline|pkg}} also performs some maintenance functions which it probably should not.
| |
| Instead a package for developers should be created with such tools.
| |
| | |
| To do this enhacenment effectively, a refactoring of the current {{codeline|pkg}} code will be needed.
| |
| [https://bitbucket.org/carandraug/octave/commits/branch/pkg This job was started once], but due to diverging and growing specifications, it stalled.
| |
| In this project we will focus on the most needed features, keeping the requirements to a minimum.
| |
| | |
| Many of these problems have been solved in other languages. Familiarity with how other languages handle this problem will be useful to come up with elegant solutions. In some cases, there are standards to follow. For example, there are specifications published by freedesktop.org about where files should go ([http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html base directory spec]) and Windows seems to have its own standards. See bugs {{bug|36477}} and {{bug|40444}} for more details.
| |
| | |
| In addition, package names may start to collide very easily. One horrible way to workaround this by is choosing increasingly complex package names that give no hint on the package purpose. A much better is option is providing an Authority category like Perl 6 does. Nested packages is also an easy way to provide packages for specialized subjects (think {{codeline|image::morphology}}). A new {{codeline|pkg}} would think all this things now, or allow their implementation at a later time. Read the [[OEP:pkg|unfinished plan]] for more details.
| |
| | |
| * '''Minimum requirements'''
| |
| : Ability to read and write Octave code, experience with Octave packages, and understanding of the basics of autotools. The most important skill is software design.
| |
| * '''Difficulty'''
| |
| : Easy to Medium.
| |
| * '''Mentor'''
| |
| : [[User:KaKiLa|KaKiLa]], Carnë Draug, Carlo de Falco, Sebastian Schöps
| |
| | |
| === Command line suggestion feature ===
| |
| | |
| 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.
| |
| | |
| 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'''
| |
| : TBD
| |
| * '''Difficulty'''
| |
| : Easy to Medium.
| |
| * '''Mentor'''
| |
| : Undetermined
| |
| | |
| == Image Analysis ==
| |
| | |
| === Improvements to N-dimensional image processing ===
| |
| | |
| The image package has partial functionality for N-dimensional images. These images exist for example in medical imaging where slices from scans are assembled to form anatomical 3D images. If taken over time and at different laser wavelengths or light filters, they can also result in 5D images. Albeit less common, images with even more dimensions also exist. However, their existence is irrelevant since most of the image processing operations are mathematical operations which are independent of the number of dimensions.
| |
| | |
| 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.
| |
| | |
| * '''Required skills'''
| |
| : m-file scripting, and a fair amount of C++ since a lot of image analysis cannot be vectorized. Familiarity with common CS algorithms and willingness to read literature describing new algorithms will be useful.
| |
| * '''Difficulty'''
| |
| : Difficult.
| |
| * '''Potential mentor'''
| |
| : Carnë Draug
| |
| | |
| === Improve Octave's image IO ===
| |
| | |
| There are a lot of image formats. To handle this, Octave uses [http://www.graphicsmagick.org/ GraphicsMagic] (GM), a library capable of handling [http://www.graphicsmagick.org/formats.html a lot of them] in a single C++ interface. However, GraphicsMagick still has its limitations. The most important are:
| |
| | |
| * 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, but building it too low 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 away 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 would implement better image IO for scientific file formats while leaving GM handle the others. Since TIFF is the de facto standard for scientific images, this should be done first. Among the targets for the project are:
| |
| | |
| * implement the Tiff class which is a wrap around libtiff, using classdef. To avoid creating too many private __oct functions, this project could also create a C++ interface to declare new Octave classdef functions.
| |
| * improve imread, imwrite, and imfinfo for tiff files using the newly created Tiff class
| |
| * port the bioformats into Octave and prepare a package for it
| |
| * investigate other image IO libraries
| |
| * clean up and finish the dicom package to include into Octave core
| |
| * prepare a matlab compatible implementation of the FITS package for inclusion in Octave core
| |
| | |
| * '''Required skills'''
| |
| : Knowledge of C++ and C since most libraries are written in those languages.
| |
| * '''Difficulty'''
| |
| : Medium.
| |
| * '''Potential mentor'''
| |
| : Carnë Draug
| |
| | |
|
| |
|
| | = Footnotes = |
|
| |
|
| | <references /> |
|
| |
|
| | = See also = |
|
| |
|
| | * https://summerofcode.withgoogle.com/ |
| | * [https://google.github.io/gsocguides/student/ GSoC Student Guide] |
| | * [https://google.github.io/gsocguides/mentor/ GSoC Mentor Guide] |
| | * [https://developers.google.com/open-source/gsoc/timeline GSoC Timeline] |
|
| |
|
| <noinclude>
| |
| [[Category:Summer of Code]] | | [[Category:Summer of Code]] |
| [[Category:Project Ideas]] | | [[Category:Project Ideas]] |
| </noinclude>
| |
