Skip to main content

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.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

# 1.3.1 (15.02.26)
- require ruranges>=0.1.1
- remove fallback compatibility hack for old ruranges versions lacking `ruranges.numpy`
- add dtype support tests for unsigned/integer interval inputs (e.g. uint32 issue case)

Install

Pyranges 1.x requires python ≥3.12. Minimal installation:

pip install pyranges1

This installs and requires ruranges>=0.1.1 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

cheatsheet (The cheatsheet above was created with pyrangeyes, a companion graphical library: https://pyrangeyes.readthedocs.io/)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyranges1-1.3.3.tar.gz (900.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pyranges1-1.3.3-py3-none-any.whl (927.2 kB view details)

Uploaded Python 3

File details

Details for the file pyranges1-1.3.3.tar.gz.

File metadata

  • Download URL: pyranges1-1.3.3.tar.gz
  • Upload date:
  • Size: 900.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for pyranges1-1.3.3.tar.gz
Algorithm Hash digest
SHA256 e15a10f5e5097bfbf081adf4e1c1ac320d37dffd5338893cd3c9ea922b66d07e
MD5 59d2cc92dc8f12128ecd4b5588a186e5
BLAKE2b-256 e2c2a54c8f2fe7fe8a079967c1de639a4d05ab5df9b406fc17f8cbcab2feea7f

See more details on using hashes here.

File details

Details for the file pyranges1-1.3.3-py3-none-any.whl.

File metadata

  • Download URL: pyranges1-1.3.3-py3-none-any.whl
  • Upload date:
  • Size: 927.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for pyranges1-1.3.3-py3-none-any.whl
Algorithm Hash digest
SHA256 7e3533d058d38d961965cfca11f51c2ee076d83c6188d9648ba172fa88ebf796
MD5 e41ad44f7677e0725afa92e903675c9c
BLAKE2b-256 342745996a94cf50bdeae2f1d9ca5cf55bf799d2c1ec496a5cb7356770c9e723

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page