README.md

Usage

Molrender creates images of the following types: model, assembly, chain, chain-list, models, or all. Either as png or jpeg.

Create all images as PNG

molrender all /path/to/5cbg.cif /path/to/out/

Create all images as JPEG

molrender all /path/to/1nmr.cif /path/to/out/ --format jpeg

Building

Build:

npm install
npm run build

Build automatically on file save:

npm run watch

Build with debug mode enabled:

DEBUG=molstar npm run watch

Build for production:

NODE_ENV=production npm run build

Scripts installation

npm run build
npm install -g

Publish

Prerelease

npm version prerelease # asumes the current version ends with '-dev.X'
npm publish --tag next

Release

npm version 0.X.0 # provide valid semver string
npm publish

Contributing

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

Funding

Funding sources include but are not limited to:

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