MolStart molecule viewer for transmembrane proteins http://molstar.org

David Sehnal b3c31bb2bb Added mol-model-props module 6 yıl önce
.vscode 5148690ae1 wip, renderables 7 yıl önce
data 8802f518d7 wip, symmetry annotation, graphql schema codegen 6 yıl önce
docs 88c9248c3f Added VolumeServer 6 yıl önce
examples 5bc9cf2397 added 1crn.cif example file 6 yıl önce
src b3c31bb2bb Added mol-model-props module 6 yıl önce
.gitattributes 6e6a0d96f7 mark package-lock as binary 7 yıl önce
.gitignore 7a4456bacb wip, render-test app, draw a red triangle, yeah 7 yıl önce
.travis.yml bdae55d09f test node 8 and 10 6 yıl önce
LICENSE f6de4a1abe Updated readme + cleanup 7 yıl önce
README.md b3c31bb2bb Added mol-model-props module 6 yıl önce
mol-star-proto.sublime-project 5e66ef9807 added sublime project file 7 yıl önce
package-lock.json abc545a997 wip mol-script, 1st compiled query 6 yıl önce
package.json b3c31bb2bb Added mol-model-props module 6 yıl önce
tsconfig.json b3c31bb2bb Added mol-model-props module 6 yıl önce
tslint.json 0393a7e9b6 Tweaks 7 yıl önce
webpack.config.js d101dbaa4f packages update, use "mini-css-extract-plugin" instead of "extract-text-webpack-plugin" 6 yıl önce

README.md

License Build Status Gitter

Mol*

The goal of Mol* (/'mol-star/) is to provide a technology stack that will serve as basis for the next-generation data delivery and analysis tools for macromolecular structure data. This is a collaboration between PDBe and RCSB PDB teams and the development will be open source and available to anyone who wants to use it for developing visualisation tools for macromolecular structure data available from PDB and other institutions.

This particular project is a prototype implementation of this technology (still under development).

Project Overview

The core of Mol* currently consists of these modules:

  • mol-task Computation abstraction with progress tracking and cancellation support.
  • mol-data Collections (integer based sets, interface to columns/tables, etc.)
  • mol-math Math related (loosely) algorithms and data structures.
  • mol-io Parsing library. Each format is parsed into an interface that corresponds to the data stored by it. Support for common coordinate, experimental/map, and annotation data formats.
  • mol-model Data structures and algorithms (such as querying) for representing molecular data (including coordinate, experimental/map, and annotation data).
  • mol-model-props Common "custom properties"
  • mol-script A scriting language for creating representations/scenes and querying (includes the MolQL query language).
  • mol-geo Creating molecular geometries.
  • mol-gl A wrapper around WebGL. Uses mol-geo to generate geometries.
  • mol-app Components for builduing UIs.
  • mol-view A reference viewer implementation.
  • mol-util Useful things that do not fit elsewhere.

Moreover, the project contains the imlementation of servers, including

  • servers/model A tool for accessing coordinate and annotation data of molecular structures.
  • servers/volume A tool for accessing volumetric experimental data related to molecular structures.

The project also contains performance tests (perf-tests), examples, and basic proof of concept apps (CIF to BinaryCIF converter and JSON domain annotation to CIF converter).

Previous Work

This project builds on experience from previous solutions:

Building & Running

Build:

npm install
npm run build

Build automatically on file save:

npm run watch
npm run watch-extra

Build/watch mol-viewer

Build

npm run build
npm run build-viewer

Watch

npm run watch
npm run watch-extra
npm run watch-viewer

Run

If not installed previously:

npm install -g http-server

...or a similar solution.

From the root of the project:

http-server -p PORT-NUMBER

and navigate to build/viewer

Contributing

Just open an issue or make a pull request. All contributions are welcome.

Roadmap

Continually develop this prototype project. As individual modules become stable, make them into standalone libraries.

Funding

Funding sources include but are not limted to:

  • RCSB PDB funding by a grant [DBI-1338415; PI: SK Burley] from the NSF, the NIH, and the US DoE