Author Topic: Documentation for VASPPlugins?  (Read 737 times)

0 Members and 1 Guest are viewing this topic.

Offline markmick

  • Regular ATK user
  • **
  • Posts: 36
  • Country: us
  • Reputation: 0
    • View Profile
Documentation for VASPPlugins?
« 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

Offline Anders Blom

  • QuantumWise Staff
  • Supreme ATK Wizard
  • *****
  • Posts: 4976
  • Country: dk
  • Reputation: 78
    • View Profile
    • QuantumWise
Re: Documentation for VASPPlugins?
« Reply #1 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 [Select]
import AddOns.VASPPlugins.Analysis as a
print dir(a)

Then you can pick a function, like createVASPDensityOfStates and do

Code: python [Select]
help(a.createVASPDensityOfStates)


Best I can offer, for now