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/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.10.tar.gz (25.8 MB view details)

Uploaded Source

Built Distribution

uproot-3.4.10-py2.py3-none-any.whl (121.8 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: uproot-3.4.10.tar.gz
  • Upload date:
  • Size: 25.8 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.10.tar.gz
Algorithm Hash digest
SHA256 7fb2a4e3d31f0308007f7ee98b3f64a37ac4f5fbc395ccdd1923f29d7990e36d
MD5 ca6036139d1f2e0c566953b45f6946a7
BLAKE2b-256 1352ca3e2c5585d474ea9758b73f7bdc5df0122da43035db87d40165c863e88f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: uproot-3.4.10-py2.py3-none-any.whl
  • Upload date:
  • Size: 121.8 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.10-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 5acaccc43a617727f799d66f087203e8eeb138dfc8013ecf87c19b4cd1e36a46
MD5 0ef50a1ac1a29673d5a2022d7bd362fd
BLAKE2b-256 a8f56d815f702974918048fb6406b231e9ac434ddb6dd97b530b65485f7c876c

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