Package gromacs :: Package analysis :: Package plugins :: Module template_plugin

Module template_plugin


Template for a plugin
======================

You can use this file to write plugins that conform to the plugin API.

Names that are supposed to be changed to more sensible values have
*TEMPLATE* in their name.


.. note::

   This plugin is the canonical example for how to structure plugins that
   conform to the plugin API (see docs :mod:`gromacs.analysis.core` for
   details).

Plugin class
------------

.. autoclass:: TEMPLATEplugin
   :members: worker_class
   :undoc-members:

Worker class
------------

The worker class performs the analysis.

.. autoclass:: _TEMPLATEplugin
   :members:

Classes

[hide private]

_TEMPLATEplugin
TEMPLATE worker class.

TEMPLATEplugin
*TEMPLATE* plugin.

Variables

[hide private]

logger = logging.getLogger('gromacs.analysis.plugins.TEMPLATE')