uproot 2.9.3

ROOT I/O in pure Python and Numpy.

uproot (originally μproot, for “micro-Python ROOT”) is a reader and (someday) 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 calls to rapidly cast data blocks in the ROOT file as Numpy arrays.

It is important to note that uproot is not maintained by the ROOT project team, so post bug reports as uproot GitHub issues, not on any ROOT forum.

Installation

Install uproot like any other Python package:

pip install uproot --user

or similar (use sudo, virtualenv, or conda if you wish).

Strict dependencies:

• Python (2.6+, 3.4+)

• Numpy

Recommended dependencies:

• lz4 compression used by some ROOT files

• lzma compression used by some ROOT files; this is part of the Python 3 standard library, so only install for Python 2

Optional dependencies:

• XRootD to access remote files

• futures for parallel processing; this is part of the Python 3 standard library, so only install for Python 2

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

Tutorial

See the project homepage for a tutorial.

Interactive tutorial

Run this tutorial on Binder.

Reference documentation

• Opening files

  • uproot.open

  • uproot.xrootd

  • uproot.iterate

• ROOT I/O

  • uproot.rootio.ROOTDirectory

  • uproot.rootio.ROOTObject

  • uproot.rootio.ROOTStreamedObject

• TTree Handling

  • uproot.tree.TTreeMethods

  • uproot.tree.TBranchMethods

• Interpretation

• Caches

• Parallel I/O