Metadata-Version: 2.4
Name: escapepod
Version: 0.6.2
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: MacOS
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Rust
Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
License-File: LICENSE
Summary: Fast Python reader/writer for Oxford Nanopore POD5 files, backed by a pure Rust engine
Keywords: nanopore,pod5,sequencing,bioinformatics,signal
Author-email: Jay Hesselberth <jay.hesselberth@gmail.com>
License-Expression: MIT
Requires-Python: >=3.9
Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
Project-URL: Documentation, https://rnabioco.github.io/escapepod-rs/python/
Project-URL: Homepage, https://github.com/rnabioco/escapepod-rs
Project-URL: Repository, https://github.com/rnabioco/escapepod-rs

# escapepod

Fast Python reader/writer for Oxford Nanopore **POD5** files, backed by a pure
Rust engine (the same engine as the [`escpod`](https://github.com/rnabioco/escapepod-rs)
CLI). It mirrors the API of Oxford Nanopore's official
[`pod5`](https://github.com/nanoporetech/pod5-file-format) package closely
enough to be a mostly drop-in replacement, while reading and writing
considerably faster.

> **Alpha quality and under active development.** APIs and output formats may
> change without notice. Verify results against the official ONT `pod5` tools
> before relying on it for anything important.

## Install

```bash
pip install escapepod
```

Wheels are published for CPython 3.9+ (abi3) on Linux (x86_64/aarch64,
manylinux + musllinux) and macOS (x86_64/arm64).

## Usage

```python
import escapepod

with escapepod.Reader("experiment.pod5") as reader:
    print(f"{reader.read_count} reads")
    for read in reader:
        signal = reader.get_signal(read)          # raw ADC (int16)
        print(read.read_id, read.num_samples, signal.mean())
```

See the [documentation](https://rnabioco.github.io/escapepod-rs/python/) for the
full API.

## License

MIT

