ROOT I/O in pure Python and NumPy.
Uproot is a library for reading and writing ROOT files in pure 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.
pip install uproot awkward
conda install -c conda-forge uproot
If you have already added
conda-forge as a channel, the
-c conda-forge is unnecessary. Adding the channel is recommended because it ensures that all of your packages use compatible versions (see conda-forge docs):
conda config --add channels conda-forge conda update --all
Start with the tutorials and reference documentation.
- Report bugs, request features, and ask for additional documentation on GitHub Issues.
- If you have a "How do I...?" question, start a GitHub Discussion with category "Q&A".
- Alternatively, ask about it on StackOverflow with the [uproot] tag. Be sure to include tags for any other libraries that you use, such as Pandas or PyTorch.
- To ask questions in real time, try the Gitter Scikit-HEP/uproot chat room.
Installation for developers
Uproot is an ordinary Python library; you can get a copy of the code with
git clone https://github.com/scikit-hep/uproot4.git
and install it locally by calling
pip install . in the repository directory.
If you need to develop Awkward Array as well, see its installation for developers.
Uproot's only strict dependency is NumPy. This is the only dependency that pip will automatically install.
Awkward Array is highly recommended. It is not a strict dependency to allow Uproot to be used in restrictive environments. If you're using Uproot without Awkward Array, you'll have to use the
library="np" option or globally set
uproot.default_library to return arrays as NumPy arrays (see documentation).
awkward: be sure to use Awkward Array 1.x.
The following libraries are also useful in conjunction with Uproot, but are not necessary. If you call a function that needs one, you'll be prompted to install it. (Conda installs most of these automatically.)
For ROOT files, compressed different ways:
xxhash: only if reading ROOT files that have been LZ4-compressed.
zstandard: only if reading ROOT files that have been ZSTD-compressed.
backports.lzma: only if reading ROOT files that have been LZMA-compressed (in Python 2).
For remote data:
xrootd: only if reading files with
For exporting data to other libraries:
pandas: only if
cupy: only if
library="cp"(reads arrays onto GPUs).
boost-histogram: only if converting histograms to boost-histogram with
hist: only if converting histograms to hist with
Support for this work was provided by NSF cooperative agreement OAC-1836650 (IRIS-HEP), grant OAC-1450377 (DIANA/HEP) and PHY-1520942 (US-CMS LHC Ops).
Thanks especially to the gracious help of Uproot contributors (including the original repository).
💻: code, 📖: documentation, 🚇: infrastructure, 🚧: maintainance, ⚠: tests and feedback, 🤔: foundational ideas.
Release history Release notifications | RSS feed
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
|Filename, size||File type||Python version||Upload date||Hashes|
|Filename, size uproot-4.1.8.tar.gz (323.5 kB)||File type Source||Python version None||Upload date||Hashes View|
|Filename, size uproot-4.1.8-py2.py3-none-any.whl (299.8 kB)||File type Wheel||Python version py2.py3||Upload date||Hashes View|
Hashes for uproot-4.1.8-py2.py3-none-any.whl