API Reference
=============

.. automodule:: pymolar

Classes
-------

.. currentmodule:: pymolar

.. autoclass:: AnalysisTask
   :members:
   :undoc-members:
   :show-inheritance:

.. autoclass:: Atom
   :members:
   :undoc-members:
   :show-inheritance:

.. autoclass:: FileHandler
   :members:
   :undoc-members:
   :show-inheritance:

.. autoclass:: FileStats
   :members:
   :undoc-members:
   :show-inheritance:

.. autoclass:: NdxFile
   :members:
   :undoc-members:
   :show-inheritance:

.. autoclass:: Particle
   :members:
   :undoc-members:
   :show-inheritance:

.. autoclass:: PeriodicBox
   :members:
   :undoc-members:
   :show-inheritance:

.. autoclass:: Sasa
   :members:
   :undoc-members:
   :show-inheritance:

.. autoclass:: Sel
   :members:
   :undoc-members:
   :show-inheritance:

.. autoclass:: SelAtomIterator
   :members:
   :undoc-members:
   :show-inheritance:

.. autoclass:: SelPosIterator
   :members:
   :undoc-members:
   :show-inheritance:

.. autoclass:: State
   :members:
   :undoc-members:
   :show-inheritance:

.. autoclass:: SysAtomIterator
   :members:
   :undoc-members:
   :show-inheritance:

.. autoclass:: SysParticleIterator
   :members:
   :undoc-members:
   :show-inheritance:

.. autoclass:: SysPosIterator
   :members:
   :undoc-members:
   :show-inheritance:

.. autoclass:: System
   :members:
   :undoc-members:
   :show-inheritance:

.. autoclass:: Topology
   :members:
   :undoc-members:
   :show-inheritance:

Functions
---------

.. currentmodule:: pymolar

.. autofunction:: distance_search

.. autofunction:: fit_transform

.. autofunction:: fit_transform_matching

.. autofunction:: greeting

.. autofunction:: rmsd_mw

.. autofunction:: rmsd_py