Skip to main content

ROOT I/O in pure Python and Numpy.

Project description

uproot

uproot (originally μproot, for “micro-Python ROOT”) is a reader and a writer of the ROOT file format using only Python and Numpy. Unlike the standard C++ ROOT implementation, uproot is only an I/O library, primarily intended to stream data into machine learning libraries in Python. Unlike PyROOT and root_numpy, uproot does not depend on C++ ROOT. Instead, it uses Numpy to cast blocks of data from the ROOT file as Numpy arrays.

Python does not necessarily mean slow. As long as the data blocks (“baskets”) are large, this “array at a time” approach can even be faster than “event at a time” C++. Below, the rate of reading data into arrays with uproot is shown to be faster than C++ ROOT (left) and root_numpy (right), as long as the baskets are tens of kilobytes or larger (for a variable number of muons per event in an ensemble of different physics samples; higher is better).

https://raw.githubusercontent.com/scikit-hep/uproot3/master/docs/root-none-muon.png https://raw.githubusercontent.com/scikit-hep/uproot3/master/docs/rootnumpy-none-muon.png

uproot is not maintained by the ROOT project team, so post bug reports here as GitHub issues, not on a ROOT forum. Thanks!

Installation

Install uproot like any other Python package:

pip install uproot3                      # maybe with sudo or --user, or in virtualenv

The pip installer automatically installs strict dependencies; the conda installer also installs optional dependencies (except for Pandas).

Strict dependencies:

Optional dependencies:

  • lz4 to read/write lz4-compressed ROOT files

  • xxhash to read/write lz4-compressed ROOT files

  • lzma to read/write lzma-compressed ROOT files in Python 2

  • xrootd to access remote files through XRootD

  • requests to access remote files through HTTP

  • pandas to fill Pandas DataFrames instead of Numpy arrays

Reminder: you do not need C++ ROOT to run uproot.

Tutorial

See the project homepage for a tutorial.

Run that tutorial on Binder.

Tutorial contents:

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

uproot3-3.14.4.tar.gz (142.2 kB view details)

Uploaded Source

Built Distribution

uproot3-3.14.4-py3-none-any.whl (117.5 kB view details)

Uploaded Python 3

File details

Details for the file uproot3-3.14.4.tar.gz.

File metadata

  • Download URL: uproot3-3.14.4.tar.gz
  • Upload date:
  • Size: 142.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/49.6.0.post20210108 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.8.6

File hashes

Hashes for uproot3-3.14.4.tar.gz
Algorithm Hash digest
SHA256 4396746ba5ef9071bb0a9da53294e4613a7f4548218940f86496e79d682d20eb
MD5 54f6b475057afa14ee23f6b08d203824
BLAKE2b-256 da305cf878119f360f831a5c2ba34b6abba52783c2aa75bb215af270a3fe3ab8

See more details on using hashes here.

File details

Details for the file uproot3-3.14.4-py3-none-any.whl.

File metadata

  • Download URL: uproot3-3.14.4-py3-none-any.whl
  • Upload date:
  • Size: 117.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/49.6.0.post20210108 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.8.6

File hashes

Hashes for uproot3-3.14.4-py3-none-any.whl
Algorithm Hash digest
SHA256 d0b513aed4af17278d582a4879eff7037efe0752c7e2154683ac4c4f083c30c0
MD5 1dd639219ba87a9f08c912d3c640114a
BLAKE2b-256 9c69d893c6eba0dd0d8f82d841d4b85b6e63c52a1b472aec7cf7ae0efedf5a92

See more details on using hashes here.

Supported by

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