https://github.com/nanoporetech/pod5-file-format
Pod5: a high performance file format for nanopore reads.
https://github.com/nanoporetech/pod5-file-format
apache-arrow file-format nanopore
Last synced: 5 months ago
JSON representation
Pod5: a high performance file format for nanopore reads.
- Host: GitHub
- URL: https://github.com/nanoporetech/pod5-file-format
- Owner: nanoporetech
- License: other
- Created: 2022-05-04T14:54:03.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-11-25T08:33:01.000Z (11 months ago)
- Last Synced: 2025-05-09T13:06:19.967Z (5 months ago)
- Topics: apache-arrow, file-format, nanopore
- Language: C++
- Homepage: https://pod5-file-format.readthedocs.io/
- Size: 28.7 MB
- Stars: 148
- Watchers: 25
- Forks: 20
- Open Issues: 36
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
[](https://pod5-file-format.readthedocs.io/)
POD5 File Format
================
POD5 File Format
================
POD5 is a file format for storing nanopore dna data in an easily accessible way.
The format is able to be written in a streaming manner which allows a sequencing
instrument to directly write the format.
Data in POD5 is stored using [Apache Arrow](https://github.com/apache/arrow), allowing
users to consume data in many languages using standard tools.
What does this project contain
------------------------------
This project contains a core library for reading and writing POD5 data, and a toolkit for
accessing this data in other languages.
Documentation
-------------
Full documentation is found at https://pod5-file-format.readthedocs.io/
Usage
-----
POD5 is also bundled as a python module for easy use in scripts, a user can install using:
```bash
> pip install pod5
```
This python module provides the python library to write custom scripts against.
Please see [examples](./python/pod5/examples) for documentation on using the library.
The `pod5` package also provides [a selection of tools](./python/pod5/README.md).
Design
------
For information about the design of POD5, see the [docs](./docs/README.md).
Development
-----------
If you want to contribute to pod5_file_format, or our pre-built binaries do not meet your platform requirements, you can build pod5 from source using the instructions in [DEV.md](DEV.md)