Python Module API
===========================

In order to run OpenFTS as a python module, your python script will look something like ::

    import openfts
    fts = openfts.OpenFTS()   # create fts object
    ...                       # edit the fts object
    fts.run()                 # run the fts object
    ...                       # extract data from fts run

Below is the comprehensive API to interface with this `fts` object (generated via sphinx.autodoc)

.. autoclass:: openfts.OpenFTS
    :members:
    :undoc-members:

.. autofunction:: openfts.get_scalar_operators

.. autofunction:: openfts.get_scalar_operator