Home

Awesome

NPM version npm Travis build status Dependency Status npm npm Gitter

Open Babel Binding for Node.js

Open Babel is a chemical toolbox designed to speak the many languages of chemical data written in C++. Now you can use the Open Babel features in node.js !

<h1 id="contents">Contents</h1> <h1 id="installation">Installation</h1> <h2 id="linux">Linux</h2>

First of all you should install openbabel with header files.

sudo apt-get install libopenbabel-dev

Then you can easily install this package using npm

npm install openbabel
<h2 id="linux">OS X</h2>

Install openbabel using brew

brew install open-babel
npm install openbabel
<h1 id="usage">Usage</h1>

Check the Documentation API for more details.

Use the openbabel module in your project.

var ob = require('openbabel');
<h2 id="usage-conversion">Conversion</h2> <h3 id="usage-conversion-read-chemical-file-formats">Read chemical file formats</h3>

Create an instance of ob.Conversion :

var conversion = new ob.Conversion();
var mol = conversion.setInFormat('smiles').read('C1CCCC1');
console.log(mol.atomsCount);

And you can use fs to read chimcal data from files :

var fs = require('fs');

var data = readFileSync('methane.smiles');
var conversion = new ob.Conversion();
var mol = conversion.setInFormat('smiles').read(data);
console.log(mol.atomsCount);
<h3 id="usage-conversion-write-chemical-file-formats">Write chemical file formats</h3>

Use an ob.Conversion instance :

var str = conversion.setOutFormat('mol').write(mol);
console.log(str);

And also you can export it as a file :

var str = conversion.setOutFormat('mol').write();
fs.writeFileSync('methane.mol', str);
<h2 id="usage-forcefield">ForceField</h2> <h3 id="usage-forcefield-energy-calculation">Energy Calculation</h3>

Create an instance of ob.Conversion using The ob.Conversion.findForceField factory :

var ff = ob.Conversion.findForceField('mmff94');
ff.setup(mol);
console.log(ff.energy);
<h3 id="usage-forcefield-conformers-search">Conformers search</h3>

Call one of systematicRotorSearch, randomRotorSearch, weightedRotorSearch. (Read more in API)

console.log(ff.energy); // Before getting conformer
ff.systematicRotorSearch();
console.log(ff.energy); // After getting conformer
<h3 id="atom-types">Atom types</h3>

You can get data which is set for an atom by calling getData method such as FFAtomType.

ff.prepareAtomTypes();
console.log(mol.atoms[0].getData('FFAtomType'));