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.5.2.tar.gz (25.9 MB view details)

Uploaded Source

Built Distribution

uproot-3.5.2-py2.py3-none-any.whl (96.6 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: uproot-3.5.2.tar.gz
  • Upload date:
  • Size: 25.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/41.0.1 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.3

File hashes

Hashes for uproot-3.5.2.tar.gz
Algorithm Hash digest
SHA256 677f228c7abf107a72ecc3e94973f8babd2a171a04b6c4ffdbf7fb9cd9a00dc4
MD5 a661b278470511690b5b70097ee6305e
BLAKE2b-256 d16ee05f70317958ac94fb54d09e7fde77c9ad4af533a8cabbac10963902d776

See more details on using hashes here.

File details

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

File metadata

  • Download URL: uproot-3.5.2-py2.py3-none-any.whl
  • Upload date:
  • Size: 96.6 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/41.0.1 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.3

File hashes

Hashes for uproot-3.5.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 ee6a4fac033e9aa4bfa3aad0367661bd87bb0edfd3f4a8b711a9044d4d50b98f
MD5 b5a6296f9cb975c93b1c1e159c1e2d99
BLAKE2b-256 a86d4ce6cfd155fd519532dd272aa13e56bf8d26260b01d9cea664dfa6c81890

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