QuantumATK Forum

QuantumATK => General Questions and Answers => Topic started by: markmick on March 2, 2016, 18:39

Title: Documentation for VASPPlugins?
Post by: markmick on March 2, 2016, 18:39

I attempted to find documentation for the VASPPlugin python commands, but was unable to locate them on the QuantumWise website.  Can someone point me in the right direction?

Thanks,
Mark

Title: Re: Documentation for VASPPlugins?
Post by: Anders Blom on March 3, 2016, 11:36

There are none. That is, it's not part of the public API. Plugins rarely are, but for most plugins we publish the source code. The VASP one is different (for various reasons), so you can't read the source.

You can reverse-engineer it quite a bit tough: you see the filenames in the AddOn directory (like Analysis.pyc). Now you can, in atkpython, do

Code: python

import AddOns.VASPPlugins.Analysis as a
print dir(a)

Then you can pick a function, like createVASPDensityOfStates and do

Code: python

help(a.createVASPDensityOfStates)

Best I can offer, for now