1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41
|
# `sourmash` Python API
The primary programmatic way of interacting with `sourmash` is via
its Python API.
**Please also see [examples of using the API](api-example.md).**
```{contents}
:depth: 2
```
## `MinHash`: basic MinHash sketch functionality
```{eval-rst}
.. autoclass:: sourmash.MinHash
:members:
.. automethod:: __init__
```
## `SourmashSignature`: save and load MinHash sketches in JSON
```{eval-rst}
.. automodule:: sourmash.signature
:members:
```
## `SBT`: save and load Sequence Bloom Trees in JSON
```{eval-rst}
.. automodule:: sourmash.sbt
:members: GraphFactory, Node, NodePos, SBT, Leaf
:undoc-members:
```
## `sourmash.fig`: make plots and figures
```{eval-rst}
.. automodule:: sourmash.fig
:members:
```
|