Skip to main content

ROOT I/O in pure Python and NumPy.

Project description

PyPI version Conda-Forge Python 2.7,3.5โ€’3.9 BSD-3 Clause License Continuous integration tests

Scikit-HEP NSF-1836650 DOI 10.5281/zenodo.4340632 Documentation Gitter

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.

Installation

Uproot can be installed from PyPI using pip. Awkward Array is optional but highly recommended:

pip install uproot awkward

Uproot is also available using conda (in this case, Awkward Array is automatically installed):

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

Getting help

Start with the tutorials and reference documentation.

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.

Dependencies

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:

  • lz4 and 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 root:// URLs.

For exporting data to other libraries:

  • pandas: only if library="pd".
  • cupy: only if library="cp" (reads arrays onto GPUs).
  • boost-histogram: only if converting histograms to boost-histogram with histogram.to_boost().
  • hist: only if converting histograms to hist with histogram.to_hist().

Acknowledgements

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).


Jim Pivarski

๐Ÿ’ป ๐Ÿ“– ๐Ÿš‡ ๐Ÿšง

Pratyush Das

๐Ÿ’ป ๐Ÿš‡

Chris Burr

๐Ÿ’ป ๐Ÿš‡

Dmitri Smirnov

๐Ÿ’ป

Matthew Feickert

๐Ÿš‡

Tamas Gal

๐Ÿ’ป

Luke Kreczko

๐Ÿ’ป โš ๏ธ

Nicholas Smith

๐Ÿ’ป

Noah Biederbeck

๐Ÿ’ป

Oksana Shadura

๐Ÿ’ป ๐Ÿš‡

Henry Schreiner

๐Ÿ’ป ๐Ÿš‡ โš ๏ธ

Mason Proffitt

๐Ÿ’ป โš ๏ธ

Jonas Rembser

๐Ÿ’ป

benkrikler

๐Ÿ’ป

Hans Dembinski

๐Ÿ“–

Marcel R.

๐Ÿ’ป

Ruggero Turra

๐Ÿ’ป

Jonas Rรผbenach

๐Ÿ’ป

bfis

๐Ÿ’ป

Raymond Ehlers

๐Ÿ’ป

Andrzej Novak

๐Ÿ’ป

Josh Bendavid

๐Ÿ’ป

Doug Davis

๐Ÿ’ป

Chao Gu

๐Ÿ’ป

Lukas Koch

๐Ÿ’ป

Michele Peresano

๐Ÿ’ป

Edoardo

๐Ÿ’ป

JMSchoeffmann

๐Ÿ’ป

alexander-held

๐Ÿ’ป

Giordon Stark

๐Ÿ’ป

Ryunosuke O'Neil

๐Ÿ’ป

ChristopheRappold

๐Ÿ“–

Cosmin Deaconu

โš ๏ธ ๐Ÿ’ป

Carlos Pegueros

๐Ÿ“– ๐Ÿ’ก โš ๏ธ โœ…

Benjamin Tovar

๐Ÿ’ป

Duncan Macleod

๐Ÿš‡

mpad

๐Ÿ’ป

๐Ÿ’ป: code, ๐Ÿ“–: documentation, ๐Ÿš‡: infrastructure, ๐Ÿšง: maintainance, โš : tests and feedback, ๐Ÿค”: foundational ideas.

Release history Release notifications | RSS feed

This version

4.1.8

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for uproot, version 4.1.8
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

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page