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 (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

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

Strict dependencies:

The following are installed automatically when you install uproot with pip:

  • Numpy (1.13.1+)

  • awkward-array to manipulate data from non-flat TTrees, such as jagged arrays (part of Scikit-HEP)

  • uproot-methods for histogram and physics object methods, such as TLorentzVector (part of Scikit-HEP)

  • cachetools for dict-like caches (replaces uproot 2’s custom caches)

  • lz4 to read lz4-compressed ROOT files (now ROOT’s default compression method)

  • lzma to read lzma-compressed ROOT files (part of Python 3’s standard library)

Optional dependencies:

  • XRootD (4+ for pyxrootd) to access remote files

  • futures for parallel processing in Python 2 (part of Python 3’s standard library)

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

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.0.0b1.tar.gz (52.2 MB view hashes)

Uploaded Source

Built Distribution

uproot-3.0.0b1-py2.py3-none-any.whl (108.5 kB view hashes)

Uploaded Python 2 Python 3

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