Awkward Array is a library for nested, variable-sized data, including arbitrary-length lists, records, mixed types, and missing data, using NumPy-like idioms.

Arrays are dynamically typed, but operations on them are compiled and fast. Their behavior coincides with NumPy when array dimensions are regular and generalizes when they’re not.

Quickstart¶

Use the left-bar for tutorials (≡ button on mobile), click below for reference documentation, or here for GitHub. Note that the most complete documentation can be found in the Python API reference: each function has a thorough docstring, usually with examples.

Installation¶

Awkward Array can be installed from PyPI using pip:

pip install awkward

Most users will get a precompiled binary (wheel) for your operating system and Python version. If not, the above attempts to compile from source.

Getting help¶

• Report bugs, request features, and ask for additional documentation on GitHub Issues.

• You can vote for issues by adding a “thumbs up” (👍) using the “smile/pick your reaction” menu on the top-right of the issue. See the prioritized list of open 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 [awkward-array] 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/awkward-array chat room.

For developers¶

See Awkward Array’s GitHub page for more on the following.

See also papers and talks about Awkward Array and a table of contributors.

Support for this work was provided by NSF cooperative agreement OAC-1836650 (IRIS-HEP), grant OAC-1450377 (DIANA/HEP), PHY-1520942 (US-CMS LHC Ops), and OAC-2103945 (Awkward Array).