Difference between revisions of "Google Summer of Code Ideas"

From MSL-Libraries
Jump to navigationJump to search
Line 38: Line 38:
  
  
1) '''Implementing a generic language-interface allowing for easy MSL use in python, R, perl, octave, etc.'''
+
1) '''Embedding MSL code for use in higher-level languages.'''
  
 
'''Brief explanation:'''
 
'''Brief explanation:'''
Line 54: Line 54:
  
  
2) '''MSL-light'''
+
2) '''MSL-Light'''
  
 
'''Brief explanation:'''
 
'''Brief explanation:'''
  
The objects in MSL are functionality-rich and sometimes too heavy (in terms of memory) for simple operations on large molecules. One idea is to implement light weight versions of some core objects. An example is the AtomContainer object that is a lighter version of the System Object.  
+
The objects in MSL are functionality-rich and sometimes too heavy (in terms of efficiency) for simple operations on large molecules. One idea is to implement light-weight versions of some core objects, for example, the AtomContainer object that is a lighter version of the System object.  
  
 
'''Expected results:'''
 
'''Expected results:'''
  
New light-weight objects could do away with some inefficiencies in core MSL which were necessary to make MSL flexible. We expect a  collection of objects that could make some simple,routine operations faster than using core MSL.
+
We expect a  collection of objects that would make some simple, routine operations faster than using core MSL.
  
 
'''Knowledge Prerequisite:'''
 
'''Knowledge Prerequisite:'''
Line 70: Line 70:
  
  
3) '''Convert MSL pointers to using a Smart/Owning pointer system'''
+
3) '''Smart pointers in MSL'''
  
 
'''Brief explanation:'''
 
'''Brief explanation:'''
Line 82: Line 82:
  
  
4) '''Create a centralized program options mechanism that makes options management easier.'''
+
4) '''Efficient program options management'''
  
 
'''Brief explanation:'''
 
'''Brief explanation:'''
Line 98: Line 98:
  
  
5) '''Create Debian/Ubuntu deb packages and Redhat rpm packages to facilitate distribution and installation.'''  
+
5) '''MSL Packages'''
  
 
'''Brief explanation:'''  
 
'''Brief explanation:'''  
Line 106: Line 106:
 
'''Expected results:'''
 
'''Expected results:'''
  
One-click/commmand MSL installation.
+
One-click/command MSL installation.
  
 
'''Knowledge Prerequisite:'''
 
'''Knowledge Prerequisite:'''
Line 113: Line 113:
  
  
6) '''Creating a web interface to run MSL programs.'''
+
6) '''Developing a website to run MSL applications.'''
  
 
'''Brief explanation:'''
 
'''Brief explanation:'''
  
There are several MSL applications that are directly useful to structural biologists. For example, the sidechain modeling programs, the structure prediction programs, etc., are of general interest and it would be useful to create a web interface that allows the use these applications with a minimal/no knowledge of MSL.
+
There are several MSL applications that are directly useful to structural biologists. For example, the sidechain modeling programs, the structure prediction programs, etc., are of general interest and it would be useful to create a web interface that allows the use of these applications with a minimal/no knowledge of MSL.
  
 
'''Expected results:'''
 
'''Expected results:'''
  
A page on the lab website that manages jobs submitted by users. This may also involve running multiple programs on the lab cluster, post processing, and making the results available.
+
A website to run MSL applications on the lab cluster, post process the output and make the results available to the user.
  
 
'''Knowledge Prerequisite:'''
 
'''Knowledge Prerequisite:'''

Revision as of 04:33, 29 March 2013

MSL (Molecular Software Libraries) is an open source C++ library of objects related to macromolecular modeling.

MSL OBJECT HIERARCHY

Goal

The goal of MSL is to create a toolbox to enable a programmer to design powerful and advanced applications for molecular analysis, modeling, prediction and design. At the same time, MSL should also allow the rapid creation of applications that perform simple tasks (for example, measuring the distance between two atoms).

History

MSL has been developed in the past 5 years (9 years if we include its early predecessor). It has an extensive code base (over 150 objects and 100,000 lines of code). After years in beta, the first stable version (1.0) was released in 2012.

The code can be downloaded at the MSL SourceForge page and the entire development tree is available at the MSL SVN repository. Several examples are now available in the repository that demonstrate the capabilities of MSL objects in modeling applications.

MSL is described in its primary citation:

  • Kulp DW, Subramaniam S, Donald JE, Hannigan BT, Mueller BK, Grigoryan G and Senes A "Structural informatics, modeling and design with an open-source Molecular Software Library (MSL)", J Comput. Chem. 2012 33(20), 1645-61 (Download PDF)


MSL has been extensively used in scientific publications encompassing a variety of applications. For example, protein structure prediction, protein design, protein engineering and modeling algorithms/methods, and others.


Current development

The focus so far has been on creating a flexible yet powerful software framework that is easily accessible to programmers familiar with C++/object-orientation. This will continue to be the main theme of MSL development and we are striving to improve the core framework through

  • more advanced objects
  • more efficient implementations
  • implementing more modeling algorithms and protocols

Another important direction is making MSL more accessible to a wider audience by

  • creating interfaces to other programming languages
  • making distribution of MSL easier
  • building ready-to-use applications
  • hosting MSL applications on web servers for public use


With these goals in mind, we have come up with a list of project ideas that will greatly help MSL developers and users.

Ideas

1) Embedding MSL code for use in higher-level languages.

Brief explanation:

The idea is to make MSL code available to programs in other higher-level languages. This could be done using an interface compiler like the SWIG (see swig.org)

Expected results:

Infrastructure and example applications in multiple higher-level languages.

Knowledge Prerequisite:

C++ and one of Python or R or perl


2) MSL-Light

Brief explanation:

The objects in MSL are functionality-rich and sometimes too heavy (in terms of efficiency) for simple operations on large molecules. One idea is to implement light-weight versions of some core objects, for example, the AtomContainer object that is a lighter version of the System object.

Expected results:

We expect a collection of objects that would make some simple, routine operations faster than using core MSL.

Knowledge Prerequisite:

C++, Data Structures and Algorithms


3) Smart pointers in MSL

Brief explanation:


Expected results:

Knowledge Prerequisite: C++


4) Efficient program options management

Brief explanation:

MSL has an advanced OptionParser object that supports name/value based program options. A mechanism needs to be implemented to group program options for MSL that uses the underlying OptionParser.

Expected results:

The mechanism developed should facilitate option reuse and in general, easy option handling in MSL applications.

Knowledge Prerequisite:

C++


5) MSL Packages

Brief explanation:

The MSL needs to be compiled from source. It would be convenient to distribute MSL as a .deb and/or .rpm package like other open source software.

Expected results:

One-click/command MSL installation.

Knowledge Prerequisite:

Linux, Make


6) Developing a website to run MSL applications.

Brief explanation:

There are several MSL applications that are directly useful to structural biologists. For example, the sidechain modeling programs, the structure prediction programs, etc., are of general interest and it would be useful to create a web interface that allows the use of these applications with a minimal/no knowledge of MSL.

Expected results:

A website to run MSL applications on the lab cluster, post process the output and make the results available to the user.

Knowledge Prerequisite:

Scripting Languages and Web Design


Please email sabareeshs@gmail.com if you would like to work on any of these ideas.