Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
Google Summer of Code 2014 Ideas
Clone this wiki locally
Attention! This is the old page!
Check the year. =)
Feel free to reach us by joining
#sciruby on chat.freenode.net or via our mailing list.
Instructions for students
See also: GSoC Student Application
We strongly recommend that you pick one of the ideas listed below. We value contributions in advance of GSoC, even if they're just little ones. Go pick out something in one of our trackers and work on it, talk to folks on the listserv, and get an idea for what features are needed.
You don't need to know a lot about Ruby to work on a project: depending on how much you already know, it'll be pretty easy to learn enough to be able to contribute. However, you may need some familiarity with scientific computation. If you don't have any, take a look at "Numerical Recipes in C", which you'll probably find in your university's library.
In any case, if you feel your skills aren't enough for some project, please ask us on our IRC channel (see contact section above) and we can help you.
Our number-one priority right now as an organization is NMatrix. Our number-two priority is most likely Minimization. We need both of these libraries for some more complicated statistical methods, some of which were actually written in pure Ruby in last year's Summer of Code; we want to speed up those methods, and to do so, we need a framework that can make use of pure C and Java facilities (which Minimization can't currently do).
Read this before you commit your first patches
Most of the main SciRuby’s landing page on Github holds the stable version of SciRuby gems but developers and contributors should work on the very latest (bleeding edge) repositories in order to make sure that changes can be committed without conflict arising.
Try reading Finding The SciRuby Development Repositories on Github if you would like a brief introduction on finding the latest development gems to work on from Github.
NMatrix is SciRuby's numerical matrix core, implementing dense matrices as well as two types of sparse (linked-list-based and Yale/CSR). NMatrix is a fairly new but well-established project which has received Summer-of-Code-like grants from both Brighter Planet and the Ruby Association (in other words, from Matz, who created Ruby). Those who contribute to NMatrix will likely eventually become authors of a jointly-published peer-reviewed science article on the library. Additionally, NMatrix is a good place to gain practical C and C++ experience, while also working to improve Ruby.
- Mentors: John Woods (@mohawkjohn), Anna Belak (@aabelak), Colin Fuller (@cjfuller)
NMatrix currently relies on ATLAS/CBLAS/CLAPACK and standard LAPACK for several of its linear algebra operations. In some cases, native versions of the functions are implemented, so that the libraries are not required. There are quite a number of areas for growth in terms of the capabilities of NMatrix here.
Ability to interface with external libraries beyond ATLAS.
Currently, the ATLAS/CBLAS/CLAPACK interface is built in to NMatrix, which makes NMatrix trickier to compile and link than it needs to be. Plus, there are use-cases of NMatrix that should not require ATLAS at all. It'd be good to see the ATLAS functionality — including ATLAS functions which NMatrix re-implements for rational numbers — abstracted into a separate gem (
nmatrix-atlas). In addition, NMatrix should have the ability to leverage other libraries that might be installed, such as eigen3, or maybe even boost (
nmatrix-boost, and perhaps
nmatrix-gsl). NMatrix should be able to switch seamlessly between them. One important design question to think about when applying: How does NMatrix choose which library to use if all three implement a given function? For example, if eigen3 and atlas both have matrix multiplication, which one should be used?
A related project is the writing of eigen3 and boost interfaces for NMatrix, though these are lower priority than adapting NMatrix to ATLAS. Another option is the Intel Math Kernel Library. Work in these areas would likely depend upon the F2RB project discussed further down the page, or perhaps FFI.
Native and Rational Functionality
As mentioned, NMatrix depends upon other libraries for many of its math functions. It makes sense to implement a lot of this functionality within NMatrix, if it can be done relatively efficiently. In particular, we would like to improve support for rational numbers in NMatrix, as well as standard Ruby objects (NMatrix can store things as integers, floating points, rationals, and Ruby objects, but how it treats those things is undefined in several cases).
A key subtask involves improving NMatrix's rational types. It doesn't make sense for us to have rational32 or rational64 types; rational128 is going to be the only one with sufficient accuracy for most purposes, and even that may not be enough for — say — astrodynamics. But some research needs to be done on how to manage overflow in this type. How does Ruby handle rational numbers with large numerators or denominators? How do other libraries handle such numbers? While eliminating rational32 and rational64, can we add a new, more graceful rational type?
It is also conceivable that an exceptionally bright student could envision a project which extended beyond rational to semi-symbolic computations. For example, many matrix calculations involve fractions like
3*sqrt(2)/2. Neither of these are rational at all! But they're so common that it should be easy to represent them. We call this semi-symbolic because there are no actual variables in the expressions — only real factors. How would computations occur on these matrices? This is a very difficult project, but would likely result in some serious credibility for an ambitious student.
Basic Matrix Math Functionality
Specifically, powers and square roots, matrix decomposition/factorization, calculation of norms, tensor products, principal component analysis (PCA), and many others. These functions are all enormously important, and would substantially improve the usability of NMatrix. Successful implementation would likely lead to co-authorship on a peer-reviewed article, and at the very least would look outstanding on a curriculum vitae.
F2RB: Fortran and C interfaces for Ruby.
- Mentors: John Woods (@mohawkjohn), Pjotr Prins (@pjotrp)
This is a new project idea which was identified as a major need for scientists working in Ruby.
Many critical science and math algorithms are written in Fortran, and it would be lovely to be able to quickly generate Ruby interfaces for these Fortran libraries — much like we can generate interfaces for C libraries in Ruby using FFI. Such a program already exists for Python (f2py). This would dramatically improve Ruby's usability for scientists and engineers.
This project requires some design and research (what solutions have already been tried, and what doesn't work?), and relates directly to the NMatrix ATLAS interface project idea.
It may be that generating Ruby-Fortran foreign function interfaces (FFIs, not to be confused with the FFI above) is hard and takes the whole summer. If so, so be it; but if in proposing the project you find that it's relatively easy, the following is suggested: create an autogenerator. Does this require use of
f2c, which translates Fortran code to C? Or can it be as simple as
require_fortran "source.f"? If you apply for GSoC with this project idea, please expect to write some sample code in your application and explain in detail how you plan to make it work.
SciRuby::Dataframe (provisional name)
- Mentors: Carlos Agarie (@agarie), Claudio Bustos (@clbustos), John Prince (@jtprince)
- SciRuby::Dataframe will be an implementation of a concept similar to Pandas (http://pandas.pydata.org/pandas-docs/dev/), which provides data structures usable by more powerful data analysis packages, like Dataframes (similar to R).
- Some requirements:
- Have some simple statistics built-in (statsample as a dependency): averages, quartiles, standard deviation, median, etc.
- Be really easy to plot. For example, a user should be able to plot a histogram from a Series object with only one method call, maybe two, without much hassle. Integration with Plotrb (see below) would be great.
- Easily receive and interpret data from a CSV file (or any delimeter separated value file), transforming it into a Dataframe with something as simple as
SciRuby::Dataframe.csv("data.csv"). This would be a wrapper around Ruby's
CSVclass. Also, chunk processing of CSV files will be necessary. The
faster_csvgem implements this.
- Be able to add/remove columns and do operations on rows or columns. For simple operations, this should be very very easy by using NMatrix's referenced slices.
- Have labeled columns and indexed rows. This means that the underlying data structure (NMatrix wrapper) will need to store some metadata.
- Use NMatrix for data storage. This also implies that we can use the NMatrix::IO module.
- As some of the requirements of this project depend on others (visualization, statistics, etc), the most important part is to design and develop it in such a way for its API to be easy to use for new users (e.g. scientists without much programming background) but extensible enough for other projects to use it.
- Extension: Semantic Web input for SciRuby
- This extension is intended to make information in a DataFrame object easily shareable shareable and reusable in a range of environments. Adding the ability to read in semantically annotated datasets would open up a range of data sources to the various SciRuby tools. By maintaining semantic information during any operations performed on the DataFrame, the data inside could be easily shared with a variety of libraries, languages, and machine agents.
- This project would involve working in collaboration with the student developing the main DataFrame project to implement basic functionality, then branching off to add additional Semantic Web Features.
- Add a facility for attaching semantic annotations to a DataFrame, as well as an interface to extract input from an RDF dataset.
- Must fully preserve information; should be able to produce the original input data.
- Would likely require programmatic generation of SPARQL queries and a deliberate choice of input vocabularies
- Inspired by Pandas and Statsample::Dataset.
Plotting with D3
- Mentors: Pjotr Prins (@pjotrp), Rob Syme, John Woods (@mohawkjohn), Anna Belak (@aabelak)
- Requirements: You should be comfortable with Ruby metaprogramming concepts, or should be prepared to learn them during the application process. You should also teach yourself Protovis and D3 during the application process, and expect to understand how other pieces of plotting software work.
User Interface: Ruby notebook and integration with other scientific tools
- Mentors: Daniel Mendler (@minad), Anna Belak (@aabelak), Alex Emly
Ruby needs a science notebook and instant plotting solution. Two examples of such pieces of software are IPython notebook and Mathematica. Ruby already has useful plotting tools, including Plotrb and Rubyvis, the first of which was a GSoC 2013 project by Wan Zuhao. Both Plotrb and Rubyvis produce publication-quality graphics. However, sometimes a researcher doesn't need publication quality; she needs a quick-and-dirty prototype. This is where interactive notebooks come in handy. Work on a Ruby notebook might also necessitate development of some additional plotting software, but is primarily a user interface and user experience project. This project is code named "Redbook."
See GSOC 2014: Ruby Notebook by @minad for a more detailed description of this idea.
Minimization and Integration
- Mentors: Claudio Bustos (@clbustos), John Woods (@mohawkjohn), Carlos Agarie (@agarie)
Minimization and Integration are two SciRuby modules which are used by Claudio Bustos' statsample gem. For Minimization, students would research and suggest additional minimization methods, develop tests, and improve documentation. For Integration, students would implement additional numerical integration methods and add support for solving various types of (ordinary and/or partial) differential equations. We need to be explicit about the imprecisions and performance of each method, so benchmarks will be necessary. As always, the student is expected to write tests and document code. There has been some talk of removing support for Ruby versions earlier than 1.9.3 for both Integration and Minimization.
- Standardized minimization framework. Right now, Minimization is pure Ruby. There are additional minimization algorithms in GSL and probably in Java which can be used in Ruby. It'd be great to have a standardized framework so that pure Ruby functions can be used, or C functions if using MRI/YARV, or Java functions if using JRuby. Such a thing is already done for the Distribution gem, so that can be used as a model.
Semantic web support for SciRuby
- Mentors: Pjotr Prins, Toshiaki Katayama, Will Strinz, Mark Wilkinson, Jerven Bolleman
- Interactive scientific tools tend to manage complex state in RAM and allows persistence after an analysis session. One example for statistics is R and its environment. The downside of this approach is that the amount of data handled is limited by memory size of the machine. We propose to use a semantic web data store (a server or a linked library) as a generic backend for interactive data analysis and session persistence in interactive Ruby. The use of a flexible data store that allows complex objects and querying using SPARQL is appealing. Applications in scientific domains, such as bioinformatics, would especially be gratifying. Notably, the bioinformatics community is doing a lot of work integrating different data repositories. Bio2RDF contains a wide range of mapped identifiers and SADI, which is the service discovery for when data is put online. A list of activities can be found here. BioRuby and biogems contain a wide range of parsers and formatters which could be extended to support reading and writing RDF (RDF is the standard of semantic web data). Having such functionality would make it easy for researchers to incorporate and expose RDF for flexible data queries.
- Approach: We will visit all existing classes, parsers and formatters and decide which ones are most useful for RDF import/export. The student will tackle one transformer at a time, writing tests and adding a SPARQL end point for others to use. The student will also add SADI service discovery. The software should be generically useful for statistical data mining and discovery.
- Difficulty and needed skills: Average difficulty
- The student is expected to develop an affinity for the semantic web during the application process (or prior), and an understanding of Ruby metaprogramming.