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

# 1.2.0 (29.01.26)
- module name changed from pyranges to pyranges1, to allow co-existing with pyranges (v0) in same env

# 1.1.9 (26.01.26)
- pandas dependency bound to v2. This is in response to pandas 3.0.0 being released, breaking our doctests.

# 1.1.8 (30.12.25)
- to_gtf and to_gff3: fix bug where 'phase' (gtf) and 'frame' (gff3) are erroneously added to attributes field

# v1.1.7 (16.12.25)
- window_ranges: fix sort order issue in  when using by (#98 and #105)
- window_ranges: added argument add_window_id, updated documentation

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.2.tar.gz (900.5 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.2-py3-none-any.whl (927.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pyranges1-1.3.2.tar.gz
  • Upload date:
  • Size: 900.5 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.2.tar.gz
Algorithm Hash digest
SHA256 c666d8ce88ec1728811edeff5e6c74168bd81a54514db4854af2f0abc8852822
MD5 78b9f65b1acf9691f7a7d1f50023f857
BLAKE2b-256 4481fe5cb16b8272bb39cdbc99a0dd7196eae59d2d27a77de2961dbbeef50547

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pyranges1-1.3.2-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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 2fb5c84480e0a6aae8db911cc9297b679c8ee303077b1d91a2b72786b2190491
MD5 2076b20f2ae3ab08bead273db8971d1d
BLAKE2b-256 0826ccaccc0f7d2f1f0cbd645aa4419b3282ad550fc62532ed53de43773fb411

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