GenomicRanges for Python.
Project description
pyranges
Introduction
Pyranges is a Python library with a Rust backend for efficient and intuitive manipulation of genomics data, particularly genomic intervals (like genes, genomic features, or reads). The library is optimized for fast querying and manipulation of genomic annotations. It enables intuitive and highly efficient pipelines for genomic analysis.
"Finally ... This was what Python badly needed for years." - Heng Li
Version 1.x
This is version 1.x of pyranges. It is a complete rewrite of the original pyranges library, soon to replace the "default" original one (version 0). If you are a v0 user, check the migration guide in the documentation.
Documentation
The pyranges documentation, including installation instructions, API, tutorial, and how-to-pages, is available at https://pyranges1.readthedocs.io/
Recent Changelog
# 1.3.6 (27.03.26)
- require `ruranges>=0.1.3`
- pick up the `ruranges` fix for `contained_intervals_only=True` overlaps when intervals share the same start coordinate
- fix `merge_overlaps` docs to refer to `count_col` instead of a nonexistent `count` parameter
# 1.3.5 (18.03.26)
- move GTF reading and attribute parsing onto the new `gtfreader>=0.2.0` dependency
- preserve semicolons inside quoted GTF attributes and keep duplicate quoted attributes in `to_rows_keep_duplicates`
- read GTF `Source` and `Frame` columns as categorical dtypes
- update GTF docs and doctests to reflect the new categorical display and supported duplicate-attribute format
- speed up GTF parsing
# 1.3.4 (14.03.26)
- accept ; in quotes in gtf attrs
- also speed up gtf parsing
# 1.3.3 (13.03.26)
- nearest_ranges: treat touching intervals as nearest matches with distance 1 instead of overlapping matches
- document touching-interval nearest behavior in doctests
# 1.3.2 (27.02.26)
- pandas 3 compatibility: removed pandas<3 constraint and aligned test matrix/dependencies
- update doctests/unit test expectations to pandas 3 native formatting (including `str` dtype display)
- remove dtype display normalization workaround in table rendering
- fix pandas 3 copy-on-write/read-only array issue in coverage path used by bigwig/rle conversion
- improve groupby `prod` compatibility across pandas 2/3 edge cases
Install
Pyranges 1.x requires python ≥3.12. Minimal installation:
pip install pyranges1
This installs and requires ruranges>=0.1.3 automatically.
Installation including all optional dependencies:
pip install pyranges1[all]
Details at https://pyranges1.readthedocs.io/en/latest/installation.html
Features
- fast
- memory-efficient
- featureful
- pythonic/pandastic
Paper/Cite
For v1:
Stovner EB, Ticó M, Muñoz del Campo E, Pallarès-Albanell J, Chawla K, Sætrom P, Mariotti M (2025) Pyranges v1: a Python framework for ultrafast sequence interval operations. bioRxiv 2025.12.11.693639; doi: https://doi.org/10.64898/2025.12.11.693639
For v0:
Stovner EB, Sætrom P (2020) PyRanges: efficient comparison of genomic intervals in Python. Bioinformatics 36(3):918-919 http://dx.doi.org/10.1093/bioinformatics/btz615
Supporting pyranges
- most importantly, cite pyranges if you use it. It is the main metric funding sources care about.
- use pyranges in Stack Overflow/biostars questions and answers
- star the repo (possibly important for github visibility and as a proxy for project popularity)
Asking for help
If you encounter bugs, or the documentation is not enough a cannot accomplish a specific task of interest, or if you'd like new features implemented, open an Issue at github: https://github.com/pyranges/pyranges/issues
Contributing to pyranges
Pyranges accepts code contributions in form of pull request. For details, visit https://pyranges1.readthedocs.io/developer_guide.html
Cheatsheet
(The cheatsheet above was created with pyrangeyes, a companion graphical library: https://pyrangeyes.readthedocs.io/)
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file pyranges1-1.3.6.tar.gz.
File metadata
- Download URL: pyranges1-1.3.6.tar.gz
- Upload date:
- Size: 899.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c7b89f366ce48db087ce273cb1a4de60e52c8304830a73d6c24423a1102f6bc5
|
|
| MD5 |
94680f25a40b628a9c89ed20bb53146c
|
|
| BLAKE2b-256 |
30d78017ad794b81a94f24b2d8e0a2b6d7f59e01d0c8f8b1c59119d0aa1de7f7
|
File details
Details for the file pyranges1-1.3.6-py3-none-any.whl.
File metadata
- Download URL: pyranges1-1.3.6-py3-none-any.whl
- Upload date:
- Size: 925.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c3d771a4671413d4964cdb9c7aed16b2ea92978e91f30b4c48521d6d9e6a2c02
|
|
| MD5 |
30dc99de5b3677f1bbde4dec8a2480c9
|
|
| BLAKE2b-256 |
53c4af34d9f911134e99b7ec2e1a5eecf046d9ff931e49c592db8e9211cf53b3
|