index.rst

Getting started

pyft: python bindings for fibertools-rs

pyft provides a python API for the rust library fibertools-rs. The inspiration for this API is to make analysis in python easier and faster; therefore, only extraction of data from a fiberseq bam is supported and not writing.

Install

pip install pyft

Vignettes

The vignettes are a good place to start to understand the capabilities of pyft.

Indices and tables

• :ref:`genindex`
• :ref:`modindex`
• :ref:`search`

.. toctree::
    :hidden:
    :maxdepth: 2
    :caption: pyft

    self
    api.rst
    vignettes/index.rst