dash-molstar

Introduction

dash-molstar is a Dash component library that integrate Molstar Viewer into Dash framework. Molstar is a modern, web-based software framework for molecular visualization and analysis. With Dash, one can use pure python code to control some basic operations of molstar and easily embed this plugin into their web page.

Installation

This library can be easily installed with pip:

pip install dash-molstar

Usage

Import dash_molstar and then you can add it to your layout as you did to other components:

import dash_molstar
from dash import Dash, html
from dash_molstar.utils import molstar_helper

app = Dash(__name__)
app.layout = html.Div(
    dash_molstar.MolstarViewer(
        id='viewer', style={'width': '500px', 'height':'500px'}
    ),
    html.Button(id='load_protein', children="Load Protein")
)

if __name__ == '__main__':
    app.run_server(debug=True)

Load a structure from local file with callback:

@app.callback(Output('viewer', 'data'), 
              Input('load_protein', 'n_clicks'),
              prevent_initial_call=True)
def display_output(yes):
    data = molstar_helper.parse_molecule('3u7y.pdb')
    return data

Or from a remote url:

@app.callback(Output('viewer', 'data'), 
              Input('load_protein', 'n_clicks'),
              prevent_initial_call=True)
def display_output(yes):
    data = molstar_helper.parse_url('https://files.rcsb.org/download/3U7Y.cif')
    return data

Clone the repository to your local directory and run the following command to see the demo:

python usage.py

To see the detailed introduction of parameters and callbacks, check out the Documentation.