api.rst

sourmash Python API

The primary programmatic way of interacting with sourmash is via its Python API. Please also see examples of using the API.

Contents

• MinHash: basic MinHash sketch functionality
• SourmashSignature: save and load MinHash sketches in JSON
• SBT: save and load Sequence Bloom Trees in JSON
• sourmash.fig: make plots and figures

MinHash: basic MinHash sketch functionality

.. autoclass:: sourmash.MinHash
   :members:

   .. automethod:: __init__

SourmashSignature: save and load MinHash sketches in JSON

.. automodule:: sourmash.signature
   :members:

SBT: save and load Sequence Bloom Trees in JSON

.. automodule:: sourmash.sbt
   :members: GraphFactory, Node, NodePos, SBT, Leaf
   :undoc-members:

sourmash.fig: make plots and figures

.. automodule:: sourmash.fig
   :members: