documentation/index.html
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Miew – 3D Molecular Viewer - Documentation</title>
<script src="scripts/prettify/prettify.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-miew.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Miew – 3D Molecular Viewer</h1>
<h3> </h3>
<section>
<article><h1>Miew – 3D Molecular Viewer</h1>
<p><a href="https://www.npmjs.com/package/miew"><img src="https://img.shields.io/npm/v/miew.svg" alt="npm version"></a>
<a href="https://travis-ci.org/epam/miew"><img src="https://img.shields.io/travis/epam/miew/master.svg?label=linux" alt="Linux Build Status"></a>
<a href="https://ci.appveyor.com/project/paulsmirnov/miew/branch/master"><img src="https://img.shields.io/appveyor/ci/paulsmirnov/miew/master.svg?label=windows" alt="Windows Build Status"></a>
<a href="https://snyk.io/test/github/epam/miew"><img src="https://snyk.io/test/github/epam/miew/badge.svg" alt="Snyk badge"></a>
<a href="https://coveralls.io/github/epam/miew"><img src="https://coveralls.io/repos/github/epam/miew/badge.svg" alt="Coverage Status"></a>
<br>
<a href="https://codeclimate.com/github/epam/miew"><img src="https://codeclimate.com/github/epam/miew/badges/gpa.svg" alt="Code Climate"></a>
<a href="https://sonarcloud.io/component_measures?id=epam:miew&metric=Maintainability"><img src="https://sonarcloud.io/api/project_badges/measure?project=epam:miew&metric=sqale_rating" alt="SonarCloud Maintainability"></a>
<a href="https://sonarcloud.io/component_measures?id=epam:miew&metric=Reliability"><img src="https://sonarcloud.io/api/project_badges/measure?project=epam:miew&metric=reliability_rating" alt="SonarCloud Reliability"></a>
<a href="https://sonarcloud.io/dashboard?id=epam:miew"><img src="https://sonarcloud.io/api/project_badges/measure?project=epam:miew&metric=alert_status" alt="Quality Gate"></a></p>
<p>Copyright (c) 2015–2022 <a href="https://www.epam.com/">EPAM Systems, Inc.</a></p>
<p>Miew is a high performance web library for advanced visualization and manipulation of molecular
structures.</p>
<p><img src="README.png" alt="Screenshot"></p>
<p>It provides a full-featured set of tools for 3D visualization and editing of small molecules as
well as large molecular complexes, including means to view, analyze, and modify the 3D structure
of a molecule. It integrates as a component into your web pages.</p>
<h2>Installation and Usage</h2>
<p>Miew library is available as an <a href="https://www.npmjs.com/">NPM</a> package. Install it either with NPM:</p>
<pre class="prettyprint source lang-sh"><code>npm install --save miew
</code></pre>
<p>or <a href="https://yarnpkg.com/">Yarn</a>:</p>
<pre class="prettyprint source lang-sh"><code>yarn add miew
</code></pre>
<p>Then use it in your <a href="https://webpack.js.org/">Webpack</a> / <a href="http://browserify.org/">Browserify</a> / <a href="https://rollupjs.org/">Rollup</a> setup, or just test it right in the Node
environment.</p>
<pre class="prettyprint source lang-js"><code>var Miew = require('miew');
console.log(Miew.VERSION);
</code></pre>
<p>You may also download the <a href="dist/Miew.min.js">minified library</a> and access it from the browser's
<code><SCRIPT></code> tag, or asynchronously include it via <a href="http://requirejs.org/">Require.js</a>. Refer to the <a href="../../documentation/jsdoc-templates/tutorials/embed.md">tutorials</a>,
<a href="../../examples/">examples</a> and API docs for more <code>details</code>.</p>
<p>There is also a <a href="https://miew.opensource.epam.com/">demo application</a> available in the git repository.</p>
<h2>Contributing</h2>
<p>Please read <a href="../../CONTRIBUTING.md">CONTRIBUTING.md</a> for details on our code of conduct, and the process for submitting pull requests to us.</p>
<h2>License</h2>
<p><a href="../../LICENSE.md">MIT</a></p></article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Namespaces</h3><ul><li><a href="SettingsObject.html">SettingsObject</a></li></ul><h3>Classes</h3><ul><li><a href="EntityList.html">EntityList</a></li><li><a href="EventDispatcher.html">EventDispatcher</a></li><li><a href="GROParser.html">GROParser</a></li><li><a href="GROReader.html">GROReader</a></li><li><a href="Helix.html">Helix</a></li><li><a href="LoaderList.html">LoaderList</a></li><li><a href="Logger.html">Logger</a></li><li><a href="Miew.html">Miew</a></li><li><a href="ParserList.html">ParserList</a></li><li><a href="PDBStream.html">PDBStream</a></li><li><a href="Strand.html">Strand</a></li><li><a href="StructuralElement.html">StructuralElement</a></li></ul><h3>Tutorials</h3><ul><li><a href="tutorial-embed.html">Embedding the Viewer</a></li><li><a href="tutorial-events.html">events</a></li><li><a href="tutorial-selectors.html">Selection Language</a></li><li><a href="tutorial-url.html">URL Query String</a></li></ul><h3><a href="global.html">Global</a></h3>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.7</a> on Thu Dec 16 2021 21:46:09 GMT+0300 (Москва, стандартное время)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>