ROOT I/O in pure Python and Numpy.

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for pivarski from gravatar.com pivarski Avatar for scikit-hep from gravatar.com scikit-hep

Unverified details

These details have not been verified by PyPI
Project links
Meta
Classifiers

Project description

uproot

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

https://raw.githubusercontent.com/scikit-hep/uproot/master/docs/root-none-muon.png https://raw.githubusercontent.com/scikit-hep/uproot/master/docs/rootnumpy-none-muon.png

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 virtualenv

or install with conda:

conda config --add channels conda-forge   # if you haven't added conda-forge already
conda install uproot

The pip installer automatically installs strict dependencies; the conda installer also installs optional dependencies (except for Pandas).

Strict dependencies:

Optional dependencies:

  • lz4 to read lz4-compressed ROOT files

  • lzma to read 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.

Tutorial

See the project homepage for a tutorial.

Run that tutorial on Binder.

Reference documentation

Project details

Verified details

These details have been verified by PyPI
Maintainers
Avatar for pivarski from gravatar.com pivarski Avatar for scikit-hep from gravatar.com scikit-hep

Unverified details

These details have not been verified by PyPI
Project links
Meta
Classifiers

Release history Release notifications | RSS feed

5.5.0

5.4.2

5.4.1

5.4.0

5.3.13

5.3.12

5.3.11

5.3.10

5.3.9

5.3.8

5.3.8rc1 pre-release

5.3.7

5.3.6

5.3.5

5.3.4

5.3.3

5.3.2

5.3.2rc1 pre-release

5.3.1

5.3.0

5.3.0rc2 pre-release

5.3.0rc1 pre-release

5.2.2

5.2.2rc1 pre-release

5.2.1

5.2.0

5.2.0rc5 pre-release

5.2.0rc4 pre-release

5.2.0rc3 pre-release

5.2.0rc2 pre-release

5.2.0rc1 pre-release

5.1.2

5.1.1

5.1.0 yanked

Reason this release was yanked:

Error in handling XRootD URLs. Use 5.1.1 (or later) instead.

5.1.0rc4 pre-release

5.1.0rc3 pre-release

5.1.0rc2 pre-release

5.1.0rc1 pre-release

5.0.13

5.0.12

5.0.11

5.0.10

5.0.9

5.0.8

5.0.7

5.0.6

5.0.5

5.0.4

5.0.3

5.0.2

5.0.1

5.0.0

5.0.0rc7 pre-release

5.0.0rc6 pre-release

5.0.0rc5 pre-release

5.0.0rc4 pre-release

5.0.0rc3 pre-release

5.0.0rc2 pre-release

5.0.0rc1 pre-release

4.3.7

4.3.6

4.3.5

4.3.4

4.3.3

4.3.2

4.3.1

4.3.0

4.2.4

4.2.3

4.2.2

4.2.1

4.2.0

4.1.9

4.1.8

4.1.7

4.1.6

4.1.5

4.1.4

4.1.3

4.1.2

4.1.1

4.1.0

4.0.11

4.0.10

4.0.9

4.0.8

4.0.7

4.0.6

4.0.5

4.0.4

4.0.3

4.0.2

4.0.2rc2 pre-release

4.0.2rc1 pre-release

4.0.1

4.0.1rc3 pre-release

4.0.1rc2 pre-release

4.0.1rc1 pre-release

4.0.0

4.0.0rc4 pre-release

4.0.0rc3 pre-release

4.0.0rc2 pre-release

3.13.1

3.13.0

3.12.0

3.11.7

3.11.6

3.11.5

3.11.4

3.11.3

3.11.2

3.11.1

3.11.0

3.10.12

3.10.11

3.10.10

3.10.9

3.10.8

3.10.7

3.10.6

3.10.5

3.10.4

3.10.3

3.10.2

3.10.1

3.10.0

3.9.3

3.9.2

3.9.1

3.9.0

3.8.2

3.8.1

3.8.0

3.7.2

3.7.1

3.7.0

3.7.0rc1 pre-release

3.6.5

3.6.4

3.6.3

This version

3.6.2

3.6.1

3.6.0

3.5.2

3.5.1

3.5.0

3.5.0rc2 pre-release

3.5.0rc1 pre-release

3.4.21

3.4.19

3.4.18

3.4.17

3.4.16

3.4.15

3.4.14

3.4.13

3.4.12

3.4.11

3.4.10

3.4.9

3.4.8

3.4.7

3.4.6

3.4.5

3.4.4

3.4.3

3.4.2

3.4.1

3.4.0

3.3.6

3.3.5

3.3.4

3.3.3

3.3.2

3.3.1

3.3.0

3.2.15

3.2.14

3.2.13

3.2.12

3.2.11

3.2.10

3.2.9

3.2.8

3.2.7

3.2.6

3.2.5

3.2.4

3.2.3

3.2.2

3.2.1

3.2.0

3.1.2

3.1.1

3.1.0

3.0.3

3.0.2

3.0.1

3.0.0

3.0.0b2 pre-release

3.0.0b1 pre-release

2.9.11

2.9.10

2.9.9

2.9.8

2.9.7

2.9.6

2.9.5

2.9.4

2.9.3

2.9.2

2.9.1

2.9.0

2.8.33

2.8.32

2.8.31

2.8.30

2.8.29

2.8.28

2.8.27

2.8.26

2.8.25

2.8.24

2.8.23

2.8.21

2.8.20

2.8.19

2.8.18

2.8.17

2.8.16

2.8.15

2.8.14

2.8.13

2.8.12

2.8.11

2.8.10

2.8.9

2.8.8

2.8.7

2.8.6

2.8.5

2.8.4

2.8.3

2.8.2

2.8.1

2.8.0

2.7.4

2.7.3

2.7.1

2.7.0

2.6.19

2.6.18

2.6.17

2.6.16

2.6.15

2.6.14

2.6.13

2.6.12

2.6.11

2.6.10

2.6.9

2.6.8

2.6.7

2.6.6

2.6.5

2.6.4

2.6.3

2.6.2

2.6.1

2.6.0

2.5.22

2.5.21

2.5.20

2.5.18

2.5.17

2.5.16

2.5.15

2.5.14

2.5.13

2.5.12

2.5.11

2.5.10

2.5.9

2.5.8

2.5.5

2.5.4

2.5.3

2.5.2

2.5.0

2.4.1

2.4.0

2.3.3

2.3.2

2.3.1

2.3.0

2.1.5

2.1.4

2.1.2

2.1.1

2.0.5

2.0.4

2.0.3

2.0.2

1.6.2

1.6.1

1.6.0

1.5.3

1.5.0

1.4.2

1.3.1

1.3.0

1.2.1

1.2.0

1.0.1

1.0.0

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.6.2.tar.gz (25.9 MB view details)

Uploaded Source

Built Distribution

uproot-3.6.2-py2.py3-none-any.whl (98.0 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file uproot-3.6.2.tar.gz.

File metadata

  • Download URL: uproot-3.6.2.tar.gz
  • Upload date:
  • Size: 25.9 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.7.3

File hashes

Hashes for uproot-3.6.2.tar.gz
Algorithm Hash digest
SHA256 de175ba2930c507a28a7a17687cde00014d36d64652d2cbdee3f8a01cfe6b321
MD5 29594543001b6c65e243cbb268847513
BLAKE2b-256 86d18dd158d4628ccf79d864fad88a327214383ba927d061c195493ab6fc4e88

See more details on using hashes here.

File details

Details for the file uproot-3.6.2-py2.py3-none-any.whl.

File metadata

  • Download URL: uproot-3.6.2-py2.py3-none-any.whl
  • Upload date:
  • Size: 98.0 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.7.3

File hashes

Hashes for uproot-3.6.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 4d2f7c94435d93b73f62ecb74bf74b2143280e4e97ba5b99320a96d305e9ca39
MD5 83441be153a083956727f4acc77eead4
BLAKE2b-256 1e26199b87c0e1404f83629dacc03f008acbfaf400496ec5953a1829d9abfdba

See more details on using hashes here.

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