README.md

OpenAD Demo Plugin

This is a demonstration plugin for OpenAD plugin developers.

You can use it as a scaffold to develop your own plugins, and to learn how to use a number of OpenAD tools in your own plugins, like visualizing molecules and other data.

Install Plugin

pip install git+https://github.com/acceleratedscience/openad-plugin-demo

To see the plugin splash screen, simply run:

demo

To see how the plugin commands are now integated in the general OpenAD help:

?

Build Your Own

First clone the plugin repo:

git clone --no-remote git@github.com:acceleratedscience/openad-plugin-demo.git

If you previously installed the GitHub version, first remove it:

pip uninstall openad-plugin-demo

Then install the downloaded repo with the --editable flag, so you can edit the plugin code:

cd openad-plugin-demo

pip install -e .

Duplicate the commands/hello_world directory as a scaffold for every command you build into your plugin.

Now relaunch openad every time you want to see an edit you made.

exit

openad

Learning

The plugin code is relatively simple and self-explanatory.
You'll find documentation across the code to help you along.

If you prefer a step-by-step guide on how to build your own plugin, head to the Plugin Developer Guide.