WebGL protein viewer
Clone or download
Permalink
Failed to load latest commit information.
.vscode package updates Apr 2, 2018
data Merge branch 'kin' into ts2 Mar 7, 2018
dist 2.0.0-dev.33 Jul 17, 2018
doc updates to make esdoc work again Aug 10, 2017
examples fixed #549 (THREE.Box3: .getSize() target is now required) Aug 7, 2018
lib Types declaration for libs (pako & mmtf) Aug 2, 2018
scripts fix release/deploy script Mar 7, 2018
src removed console.log statement Aug 7, 2018
test fixed more linting errors Apr 1, 2018
types/webvr-api package update and various fixes, webvr type workaround Aug 6, 2018
.babelrc change file mode Oct 20, 2016
.codeclimate.yml more exclusion for codeclimate Jan 30, 2017
.esdoc.json updates to make esdoc work again Aug 10, 2017
.gitattributes mark package-lock as binary Apr 16, 2018
.gitignore wip: fix export declaration issues for autogenerated d.ts file Aug 1, 2018
.travis.yml remove travis test with node 6, add test for node 10 Aug 6, 2018
CHANGELOG.md missing changelog entry May 19, 2017
DEVELOPMENT.md added note about buble and removed obsolete paragraph Jul 17, 2017
LICENSE simplified license file May 21, 2017
README.md typo Jun 20, 2018
ngl.sublime-project added rollup to sublime build-systems Dec 1, 2016
package-lock.json fixed package-lock, fixed jest config Aug 6, 2018
package.json fixed package-lock, fixed jest config Aug 6, 2018
rollup.config.js removed unused rollup option Feb 2, 2018
tsconfig.json package update and various fixes, webvr type workaround Aug 6, 2018
tslint.json more ts conversions, fisrt test running with jest, docs with typedoc Sep 9, 2017

README.md

License Changelog npm version Build Status Standard Gitter

NGL Viewer is a web application for molecular visualization. WebGL is employed to display molecules like proteins and DNA/RNA with a variety of representations.

See it in action:

Documentation:

Features

  • Molecular structures (mmCIF, PDB, PQR, GRO, SDF, MOL2, MMTF)
  • Density volumes (MRC/MAP/CCP4, DX/DXBIN, CUBE, BRIX/DSN6, XPLOR/CNS)
  • User interaction (mouse picking, selection language, animation, image export)
  • Coordinate trajectories (DCD & PSF, NCTRAJ & PRMTOP, TRR/XTC & TOP, remote access via MDSrv)
  • Embeddable (single file, API)

Usage

Since the NGL Viewer is a set of static files to be viewed in a web-browser there is not much of an installation needed. For development purposes it will be helpful to clone this repository and serve it locally (see below). When embedding the NGL Viewer as a library it is sufficient to include the self contained build dist/ngl.js. A full web application including a GUI can be found in the examples directory.

To install the current release from npm do npm install ngl. To install a development release from npm do npm install ngl@next or npm install ngl@ts2.

Acknowledgments

This project would not be possible without many fine open-source projects. Especially the three.js project provides a great foundation.

Funding sources:

  • RCSB PDB funding by a grant [DBI-1338415; PI: SK Burley] from the NSF, the NIH, and the US DoE
  • NCI/NIH award number U01 CA198942
  • DFG Projekt HI 1502

Cite

When using NGL please cite:

  • AS Rose, AR Bradley, Y Valasatava, JM Duarte, A Prlić and PW Rose. NGL viewer: web-based molecular graphics for large complexes. Bioinformatics: bty419, 2018. doi:10.1093/bioinformatics/bty419
  • AS Rose and PW Hildebrand. NGL Viewer: a web application for molecular visualization. Nucl Acids Res (1 July 2015) 43 (W1): W576-W579 first published online April 29, 2015. doi:10.1093/nar/gkv402