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 and root_numpy, 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).

https://raw.githubusercontent.com/scikit-hep/uproot/master/docs/root-none-muon.png https://raw.githubusercontent.com/scikit-hep/uproot/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 uproot                        # maybe with sudo or --user, or in virtualenv

or install with conda:

conda config --add channels conda-forge   # if you haven't added conda-forge already
conda install uproot

The pip installer automatically installs strict dependencies; the conda installer installs optional dependencies, too.

Strict dependencies:

Optional dependencies:

  • lz4 to read lz4-compressed ROOT files

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

  • xrootd to access remote files through XRootD

  • requests to access remote files through HTTP

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

Tutorial

See the project homepage for a tutorial.

Run that tutorial on Binder.

Reference documentation

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

uproot-3.4.6.tar.gz (56.9 MB view details)

Uploaded Source

Built Distribution

uproot-3.4.6-py2.py3-none-any.whl (120.2 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file uproot-3.4.6.tar.gz.

File metadata

  • Download URL: uproot-3.4.6.tar.gz
  • Upload date:
  • Size: 56.9 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.1

File hashes

Hashes for uproot-3.4.6.tar.gz
Algorithm Hash digest
SHA256 1fafe476c26252e4dbd399456323778e76d23dc2f43cf6581a707d1647978610
MD5 c51ecc81b53733e3da5e3140de95ce58
BLAKE2b-256 c020fa4bb77a4aff37852686a197ba0218382f649cea3a4f1e976d77a95bfa12

See more details on using hashes here.

File details

Details for the file uproot-3.4.6-py2.py3-none-any.whl.

File metadata

  • Download URL: uproot-3.4.6-py2.py3-none-any.whl
  • Upload date:
  • Size: 120.2 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.1

File hashes

Hashes for uproot-3.4.6-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 79223fbb99950e2e22bab0a763fbddf2a17a7eef1b08b3856189591271d24603
MD5 d19876f46a615e1bf7637cf63f0fe39a
BLAKE2b-256 26ea830fc1f7676bd66a831186c61b37068a8e493cc3c0e1340e14273d1f53d0

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