ROOT I/O in pure Python and Numpy.
Project description
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).
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 virtualenvor install with conda:
conda config --add channels conda-forge # if you haven't added conda-forge already
conda install uprootThe pip installer automatically installs strict dependencies; the conda installer also installs optional dependencies (except for Pandas).
Strict dependencies:
numpy (1.13.1+)
awkward-array (0.12.0+)
uproot-methods (0.7.0+)
Optional dependencies:
lz4 to read/write lz4-compressed ROOT files
xxhash to read/write lz4-compressed ROOT files
lzma to read/write lzma-compressed ROOT files in Python 2
xrootd to access remote files through XRootD
requests to access remote files through HTTP
pandas to fill Pandas DataFrames instead of Numpy arrays
Reminder: you do not need C++ ROOT to run uproot.
Testing and development requirements
The packages need to run the test suite can be installed via pip install "uproot[testing]". Here is an example how to set up a development
git clone https://github.com/scikit-hep/uproot.git # alternatively your own fork
cd uproot
python -m venv venv # create a virtual environment in the folder venv
. venv/bin/activate # activate the Python environment
pip install -e ".[testing]" # installs uproot in editable mode with all packages required for testing
pytest # run the test suiteTutorial
See the project homepage for a tutorial.
Run that tutorial on Binder.
Tutorial contents:
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
Built Distribution
File details
Details for the file uproot-3.13.1.tar.gz.
File metadata
- Download URL: uproot-3.13.1.tar.gz
- Upload date:
- Size: 144.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.24.0 setuptools/49.6.0.post20201009 requests-toolbelt/0.9.1 tqdm/4.52.0 CPython/3.8.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 099b0b274dc000faf724df835579c76306e60200a5ba7b600a0c4b76dabbf344 |
|
| MD5 | 855781bf7c5ccd2f46ac434304afb404 |
|
| BLAKE2b-256 | 9618a90553866f98e995b8f5290cc2a38effc6aba228f9f0c2e71318cc06ec56 |
File details
Details for the file uproot-3.13.1-py3-none-any.whl.
File metadata
- Download URL: uproot-3.13.1-py3-none-any.whl
- Upload date:
- Size: 118.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.24.0 setuptools/49.6.0.post20201009 requests-toolbelt/0.9.1 tqdm/4.52.0 CPython/3.8.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 646026a30e57b1d874183f10cb11e84eed969a3a767a38dbc3d8c305f6f0c381 |
|
| MD5 | dddb37e6eef2cfcd96d0d790ff857cf5 |
|
| BLAKE2b-256 | 841bf342da11e3a09a74d987032c55c79ab573f552c41db48135ed856a0dbda7 |
