Skip to main content

Vector classes and utilities

Project description

Vector logo

Vector: arrays of 2D, 3D, and Lorentz vectors

DOI DOI Scikit-HEP

Actions Status Documentation Status pre-commit.ci status codecov percentage

PyPI platforms PyPI version Conda latest release

LICENSE GitHub Discussion Gitter

Installation

You can install Vector with pip and conda.

pip install vector

Introduction

Vector is a Python library for 2D and 3D spatial vectors, as well as 4D space-time vectors. It is especially intended for performing geometric calculations on arrays of vectors, rather than one vector at a time in a Python for loop.

Vector is part of the Scikit-HEP project, High Energy Physics (HEP) tools in Python.

Coordinate systems

Vectors may be expressed in any of these coordinate systems:

  • the azimuthal plane may be Cartesian x y or polar rho ($\rho$) phi ($\phi$)
  • the longitudinal axis may be Cartesian z, polar theta ($\theta$), or pseudorapidity eta ($\eta$)
  • the temporal component for space-time vectors may be Cartesian t or proper time tau ($\tau$)

in any combination. (That is, 4D vectors have 2×3×2 = 12 distinct coordinate systems.)

Diagram of coordinate systems

Backends

Vectors may be included in any of these data types:

Each of these "backends" provides the same suite of properties and methods, through a common "compute" library.

Geometric versus momentum

Finally, vectors come in two flavors:

  • geometric: only one name for each property or method
  • momentum: same property or method can be accessed with several synonyms, such as pt ($p_T$, transverse momentum) for the azimuthal magnitude rho ($\rho$) and energy and mass for the Cartesian time t and proper time tau ($\tau$).

Familiar conventions

Names and coordinate conventions were chosen to align with ROOT's TLorentzVector and Math::LorentzVector, as well as scikit-hep/math, uproot-methods TLorentzVector, henryiii/hepvector, and coffea.nanoevents.methods.vector.

Getting help

Contributing to Vector

If you want to contribute to Vector, pull requests are welcome!

Please install the latest version of the main branch from source or a fork:

git clone https://github.com/scikit-hep/vector.git
cd vector
pip install -e .

Refer to CONTRIBUTING.md for more.

Citing Vector

To cite Vector, please use DOI

@article{Chopra2025,
doi = {10.21105/joss.07791},
url = {https://doi.org/10.21105/joss.07791},
year = {2025}, publisher = {The Open Journal},
volume = {10},
number = {109},
pages = {7791},
author = {Saransh Chopra and Henry Schreiner and Eduardo Rodrigues and Jonas Eschle and Jim Pivarski},
title = {Vector: JIT-compilable mathematical manipulations of ragged Lorentz vectors},
journal = {Journal of Open Source Software}
}

Documentation

Tutorials

Vector constructors

Vector functions

More ways to learn

Contributors

Thanks goes to these wonderful people (emoji key):

Jim Pivarski
Jim Pivarski

🚧 💻 📖
Henry Schreiner
Henry Schreiner

🚧 💻 📖
Eduardo Rodrigues
Eduardo Rodrigues

🚧 💻 📖
N!no
N!no

📖
Peter Fackeldey
Peter Fackeldey

📖
Luke Kreczko
Luke Kreczko

💻
Nicholas Smith
Nicholas Smith

🤔
Jonas Eschle
Jonas Eschle

🤔
Saransh Chopra
Saransh Chopra

🚧 💻 📖

This project follows the all-contributors specification. Contributions of any kind welcome! See CONTRIBUTING.md for information on setting up a development environment.

Acknowledgements

This library was primarily developed by Saransh Chopra, Henry Schreiner, Jim Pivarski, Eduardo Rodrigues, and Jonas Eschle.

Support for this work was provided by the National Science Foundation cooperative agreement OAC-1836650 and PHY-2323298 (IRIS-HEP) and OAC-1450377 (DIANA/HEP). Any opinions, findings, conclusions or recommendations expressed in this material are those of the authors and do not necessarily reflect the views of the National Science Foundation.

Project details


Download files

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

Source Distribution

vector-1.6.3.tar.gz (352.9 kB view details)

Uploaded Source

Built Distribution

vector-1.6.3-py3-none-any.whl (179.6 kB view details)

Uploaded Python 3

File details

Details for the file vector-1.6.3.tar.gz.

File metadata

  • Download URL: vector-1.6.3.tar.gz
  • Upload date:
  • Size: 352.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for vector-1.6.3.tar.gz
Algorithm Hash digest
SHA256 a85149a62fcaa8a4d95214ca217f3910ea6800d79d65ef1cfb1005720b4f713a
MD5 ab98b4d759e0d194bbccb36f9e493a60
BLAKE2b-256 1295b395e13a19b081d639f567b4013eb70e0bf346c43e3df98f95862a276b16

See more details on using hashes here.

Provenance

The following attestation bundles were made for vector-1.6.3.tar.gz:

Publisher: cd.yml on scikit-hep/vector

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file vector-1.6.3-py3-none-any.whl.

File metadata

  • Download URL: vector-1.6.3-py3-none-any.whl
  • Upload date:
  • Size: 179.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for vector-1.6.3-py3-none-any.whl
Algorithm Hash digest
SHA256 cdfbb6d1ea3100db56317812e53bb6aacb9d35fc9fff282066c4cc19fe5aab46
MD5 eabfb1129cb1084b5b4fa99db2361d3b
BLAKE2b-256 bb3e0bdbe6b3a492d89df040f751cdd21505485250c3710b54122a3226fca849

See more details on using hashes here.

Provenance

The following attestation bundles were made for vector-1.6.3-py3-none-any.whl:

Publisher: cd.yml on scikit-hep/vector

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page