Welcome to Poriscope’s documentation!

poriscope is a modular analysis package for nanopore data that can be easily extended through user-supplied plugins that conform to the poriscope API. It is both a graphical desktop app that facilitates most common solid-state nanopore analysis tasks, and a set of python objects that can be used to build custom workflows in your own python scripts. This documentation package provides complete guides for users who want to analyze nanopore data, developers who want to contribute plugins to the poriscope repository, and a complete set of API references.

If you are interested in contributing to poriscope, fork the repository and use the guides below to get started.

poriscope is an actively developed community project. If you find bugs, or if you have questions that are not anwered in this guide, feel free to reach out to the TCossaLab or submit an issue with the details.

Logging Decorators:

Indices and tables