nrnb / GoogleSummerOfCode

Main documentation site for NRNB GSoC project ideas and resources
116 stars 39 forks source link

Improved rendering of genetic designs using VisBOL #125

Closed cjmyers closed 3 years ago

cjmyers commented 5 years ago

Background

VisBOL is a genetic design visualization tool written in Javascript that runs in the browser. VisBOL can create this visualization by reading genetic design information encoding using the Synthetic Biology Open Language (SBOL) data standard. The rendering created utilizes glyphs and visualization conventions that are described in the SBOL Visual standard. VisBOL can be deployed as a standalone browser application such as at VisBOL.org. It can also be deployed as a frontend component within a larger project, such as SynBioHub.

While the original version of VisBOL focused only on rendering DNA-level designs, recent updates have begun to add non-DNA components, such as small molecules, RNAs, and proteins, as well as the interactions between these components, in order to support SBOL Visual 2. However, VisBOL suffers from some limitations. For example, its linear display list based renderer cannot be used to render nested hierarchies of components, and its dependence on a browser environment means it cannot be used offline outside of the Web browser or as a RESTful API.

Goal

The limitations present in VisBOL have already been addressed in the derivative SynBioCAD project. However, SynBioCAD lacks recent updates to VisBOL such as the addition of SBOL Visual 2 glyphs. The goals of this project would be (a) to integrate the latest updates to VisBOL into SynBioCAD, and (b) to update the VisBOL website to use SynBioCAD as its backend ("VisBOL 2.0"). A stretch goal will be to update the SynBioHub repository to use VisBOL 2.0 as its design renderer.

Difficulty Level 2

This project has a medium level of difficulty due to the challenge of working with complex codebases and Web technology.

Skills

Students need not have any experience with biology, but it would help to be proficient in any of JavaScript, TypeScript, or Node.js with some experience developing browser applications. Students will have some flexibility in choosing which aspects of the project they want to work on. Students will be required to familiarize themselves with core aspects of the SBOL data specification and SBOL Visual specification.

Public Repository

visbol-js SynBioCAD

Potential Mentors

Chris Myers, University of Utah, US (myers@ece.utah.edu) James McLaughlin, Newcastle University, UK (james@mclgh.net)

Contact

For more information, please comment on this issue or contact James McLaughlin.

7vikpeculiar commented 5 years ago

Hi @cjmyers @zachzundel @udp I am interested in working on this project, I am a computational biology student at IIIT Hyderabad, with good experience in building JavaScript-based browser applications

cjmyers commented 5 years ago

@7vikpeculiar that's great. Please see if you clone the software and get it up and running. Let us know if you have any questions.

7vikpeculiar commented 5 years ago

@cjmyers I have been able to successfully setup the software and get it up

cjmyers commented 5 years ago

Great. Please let us know if you have any questions as you begin to explore the codebase.

On Mar 18, 2019, at 12:11 PM, 7vikpeculiar notifications@github.com wrote:

@cjmyers https://github.com/cjmyers I have been able to successfully setup the software and get it up

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/nrnb/GoogleSummerOfCode/issues/125#issuecomment-474037869, or mute the thread https://github.com/notifications/unsubscribe-auth/ADWD91mZUcwFlVywr-W__vrfeHDic5SBks5vX9a3gaJpZM4Zskqa.

gaurlakshya commented 4 years ago

Hello @cjmyers i want to work on this project . i have good knowledge in the field of web development . I am a B.tech student of 2nd year (C.S.E. department). Can i work on this project ??

cjmyers commented 4 years ago

Sorry but GSoC has concluded for this year. We will hopefully be doing this project or a similar one next year. Please check back later.