pyjet

The interface between FastJet and NumPy

These details have not been verified by PyPI

Project links

Homepage

Project description

pyjet allows you to perform jet clustering with FastJet on NumPy arrays. By default pyjet only depends on NumPy and internally uses FastJet’s standalone fjcore release. The interface code is written in Cython that then becomes compiled C++, so it’s fast. Remember that if you use pyjet then you are using FastJet and should cite the papers listed here.

Strict dependencies

Python (2.7+, 3.5+)
Numpy

Getting started

pyjet provides the cluster() function that takes a NumPy array as input and returns a ClusterSequence from which you can access the jets:

from pyjet import cluster
from pyjet.testdata import get_event

vectors = get_event()
sequence = cluster(vectors, R=1.0, p=-1)
jets = sequence.inclusive_jets()  # list of PseudoJets
exclusivejets = sequence.exclusive_jets(3)  # Find the cluster history when there are 3 jets

The input is given in the form of a structured array in numpy. The first four fields of the input array vectors must be either:

np.dtype([('pT', 'f8'), ('eta', 'f8'), ('phi', 'f8'), ('mass', 'f8')])

or if cluster(..., ep=True):

np.dtype([('E', 'f8'), ('px', 'f8'), ('py', 'f8'), ('pz', 'f8')])

Note that the field names of the input array need not match ‘pT’, ‘eta’, ‘phi’, ‘mass’ etc. pyjet only assumes that the first four fields are those quantities. This array may also have additional fields of any type. Additional fields will then become attributes of the PseudoJet objects.

See the examples to get started:

https://github.com/scikit-hep/pyjet/raw/master/examples/jet_areas.png

Standalone Installation

To simply use the built-in FastJet source, from your virtual environment, run:

python -m pip install pyjet

And you’re good to go! If you have a old version of pip (<10), you will need to have Cython and Numpy already installed to build from source - however on most systems, you should get a binary wheel.

Get example.py and run it:

    curl -O https://raw.githubusercontent.com/scikit-hep/pyjet/master/examples/example.py
    python example.py
    jet#          pT        eta        phi       mass  #constit.
    1        983.280     -0.868      2.905     36.457         34
    2        901.745      0.221     -0.252     51.850         34
    3         67.994     -1.194     -0.200     11.984         32
    4         12.465      0.433      0.673      5.461         13
    5          6.568     -2.629      1.133      2.099          9
    6          6.498     -1.828     -2.248      3.309          6

    The 6th jet has the following constituents:
    PseudoJet(pt=0.096, eta=-2.166, phi=-2.271, mass=0.000)
    PseudoJet(pt=2.200, eta=-1.747, phi=-1.972, mass=0.140)
    PseudoJet(pt=1.713, eta=-2.037, phi=-2.469, mass=0.940)
    PseudoJet(pt=0.263, eta=-1.682, phi=-2.564, mass=0.140)
    PseudoJet(pt=1.478, eta=-1.738, phi=-2.343, mass=0.940)
    PseudoJet(pt=0.894, eta=-1.527, phi=-2.250, mass=0.140)

    Get the constituents as an array (pT, eta, phi, mass):
    [( 0.09551261, -2.16560157, -2.27109083,   4.89091390e-06)
     ( 2.19975694, -1.74672746, -1.97178728,   1.39570000e-01)
     ( 1.71301882, -2.03656511, -2.46861524,   9.39570000e-01)
     ( 0.26339374, -1.68243005, -2.56397904,   1.39570000e-01)
     ( 1.47781519, -1.7378898 , -2.34304346,   9.39570000e-01)
     ( 0.89353864, -1.52729244, -2.24973202,   1.39570000e-01)]

    or (E, px, py, pz):
    [( 0.42190436, -0.06155242, -0.07303395, -0.41095089)
     ( 6.50193926, -0.85863306, -2.02526044, -6.11692764)
     ( 6.74203628, -1.33952806, -1.06775374, -6.45273802)
     ( 0.74600384, -0.22066287, -0.1438199 , -0.68386087)
     ( 4.43164941, -1.0311407 , -1.05862485, -4.07096881)
     ( 2.15920027, -0.56111108, -0.69538886, -1.96067711)]

Reclustering the constituents of the hardest jet with the kt algorithm
[PseudoJet(pt=983.280, eta=-0.868, phi=2.905, mass=36.457)]

Go back in the clustering sequence to when there were two jets
PseudoJet(pt=946.493, eta=-0.870, phi=2.908, mass=20.117)
PseudoJet(pt=36.921, eta=-0.800, phi=2.821, mass=4.119)

Ask how many jets there are with a given dcut
There are 9 jets with a dcut of 0.5

Get the jets with the given dcut
1 PseudoJet(pt=308.478, eta=-0.865, phi=2.908, mass=2.119)
2 PseudoJet(pt=256.731, eta=-0.868, phi=2.906, mass=0.140)
3 PseudoJet(pt=142.326, eta=-0.886, phi=2.912, mass=0.829)
4 PseudoJet(pt=135.971, eta=-0.870, phi=2.910, mass=0.140)
5 PseudoJet(pt=91.084, eta=-0.864, phi=2.899, mass=1.530)
6 PseudoJet(pt=30.970, eta=-0.831, phi=2.822, mass=2.124)
7 PseudoJet(pt=7.123, eta=-0.954, phi=2.939, mass=1.017)
8 PseudoJet(pt=5.951, eta=-0.626, phi=2.818, mass=0.748)
9 PseudoJet(pt=4.829, eta=-0.812, phi=3.037, mass=0.384)

Using an External FastJet Installation

To take advantage of the full FastJet library and optimized O(NlnN) kt and anti-kt algorithms you can first build and install FastJet and then install pyjet with the --external-fastjet flag. Before building FastJet you will need to install CGAL and GMP.

On a Debian-based system (Ubuntu):

sudo apt-get install libcgal-dev libcgal11v5 libgmp-dev libgmp10

On an RPM-based system (Fedora):

sudo dnf install gmp.x86_64 gmp-devel.x86_64 CGAL.x86_64 CGAL-devel.x86_64

On Mac OS:

brew install cgal gmp wget

Then run pyjet’s install-fastjet.sh script:

curl -O https://raw.githubusercontent.com/scikit-hep/pyjet/master/install-fastjet.sh
chmod +x install-fastjet.sh
sudo ./install-fastjet.sh

Now install pyjet like:

python -m pip install numpy Cython
python setup.py install --external-fastjet

pyjet will now use the external FastJet installation on your system.

Note on units

The package is indifferent to particular units, which are merely “propagated” through the code. We do recommend that the HEP units be used, as defined in the units module of the hepunits package.

It is worth noting that the azimuthal angle phi is expressed in radians and varies from pi to pi.

Developing

If you want to setup for development:

python3 -m venv .env
source .env/bin/activate
pip install -e .[dev]
pytest

Project details

These details have not been verified by PyPI

Project links

Homepage

Release history Release notifications | RSS feed

1.9.0

Jul 1, 2022

1.8.2

Jan 18, 2021

1.8.1

Jan 12, 2021

1.8.0

Nov 24, 2020

This version

1.7.0

Nov 13, 2020

1.6.0

Dec 28, 2019

1.5.0

May 7, 2019

1.4.0

Jan 10, 2019

1.3.0

Aug 11, 2018

1.2.0

Jul 18, 2018

1.1.1

Apr 4, 2018

1.0.1

Aug 10, 2017

1.0.0

Jun 7, 2017

0.5.1

Jun 6, 2017

0.5.0

Jun 6, 2017

0.4.0

Jun 2, 2017

0.3.0

Jun 1, 2017

0.2.0

May 29, 2017

0.1.0

May 27, 2017

0.0.4

May 24, 2017

0.0.3

May 23, 2017

0.0.2

May 23, 2017

0.0.1

May 23, 2017

Download files

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

Source Distribution

pyjet-1.7.0.tar.gz (100.2 kB view details)

Uploaded Nov 13, 2020 Source

Built Distributions

pyjet-1.7.0-pp37-pypy37_pp73-manylinux2010_x86_64.whl (296.9 kB view details)

Uploaded Nov 13, 2020 PyPy manylinux: glibc 2.12+ x86-64

pyjet-1.7.0-pp37-pypy37_pp73-macosx_10_9_x86_64.whl (267.9 kB view details)

Uploaded Nov 13, 2020 PyPy macOS 10.9+ x86-64

pyjet-1.7.0-pp36-pypy36_pp73-manylinux2010_x86_64.whl (296.9 kB view details)

Uploaded Nov 13, 2020 PyPy manylinux: glibc 2.12+ x86-64

pyjet-1.7.0-pp36-pypy36_pp73-macosx_10_9_x86_64.whl (267.9 kB view details)

Uploaded Nov 13, 2020 PyPy macOS 10.9+ x86-64

pyjet-1.7.0-pp27-pypy_73-manylinux2010_x86_64.whl (296.9 kB view details)

Uploaded Nov 13, 2020 PyPy manylinux: glibc 2.12+ x86-64

pyjet-1.7.0-pp27-pypy_73-macosx_10_9_x86_64.whl (267.7 kB view details)

Uploaded Nov 13, 2020 PyPy macOS 10.9+ x86-64

pyjet-1.7.0-cp39-cp39-manylinux1_x86_64.whl (1.1 MB view details)

Uploaded Nov 13, 2020 CPython 3.9

pyjet-1.7.0-cp39-cp39-manylinux1_i686.whl (1.1 MB view details)

Uploaded Nov 13, 2020 CPython 3.9

pyjet-1.7.0-cp39-cp39-macosx_10_9_x86_64.whl (314.6 kB view details)

Uploaded Nov 13, 2020 CPython 3.9 macOS 10.9+ x86-64

pyjet-1.7.0-cp38-cp38-manylinux1_x86_64.whl (1.1 MB view details)

Uploaded Nov 13, 2020 CPython 3.8

pyjet-1.7.0-cp38-cp38-manylinux1_i686.whl (1.1 MB view details)

Uploaded Nov 13, 2020 CPython 3.8

pyjet-1.7.0-cp38-cp38-macosx_10_9_x86_64.whl (314.6 kB view details)

Uploaded Nov 13, 2020 CPython 3.8 macOS 10.9+ x86-64

pyjet-1.7.0-cp37-cp37m-manylinux1_x86_64.whl (1.2 MB view details)

Uploaded Nov 13, 2020 CPython 3.7m

pyjet-1.7.0-cp37-cp37m-manylinux1_i686.whl (1.1 MB view details)

Uploaded Nov 13, 2020 CPython 3.7m

pyjet-1.7.0-cp37-cp37m-macosx_10_9_x86_64.whl (314.5 kB view details)

Uploaded Nov 13, 2020 CPython 3.7m macOS 10.9+ x86-64

pyjet-1.7.0-cp36-cp36m-manylinux1_x86_64.whl (1.2 MB view details)

Uploaded Nov 13, 2020 CPython 3.6m

pyjet-1.7.0-cp36-cp36m-manylinux1_i686.whl (1.1 MB view details)

Uploaded Nov 13, 2020 CPython 3.6m

pyjet-1.7.0-cp36-cp36m-macosx_10_9_x86_64.whl (315.4 kB view details)

Uploaded Nov 13, 2020 CPython 3.6m macOS 10.9+ x86-64

pyjet-1.7.0-cp35-cp35m-manylinux1_x86_64.whl (1.1 MB view details)

Uploaded Nov 13, 2020 CPython 3.5m

pyjet-1.7.0-cp35-cp35m-manylinux1_i686.whl (1.1 MB view details)

Uploaded Nov 13, 2020 CPython 3.5m

pyjet-1.7.0-cp35-cp35m-macosx_10_9_x86_64.whl (312.0 kB view details)

Uploaded Nov 13, 2020 CPython 3.5m macOS 10.9+ x86-64

pyjet-1.7.0-cp27-cp27mu-manylinux1_x86_64.whl (1.1 MB view details)

Uploaded Nov 13, 2020 CPython 2.7mu

pyjet-1.7.0-cp27-cp27mu-manylinux1_i686.whl (1.1 MB view details)

Uploaded Nov 13, 2020 CPython 2.7mu

pyjet-1.7.0-cp27-cp27m-manylinux1_x86_64.whl (1.1 MB view details)

Uploaded Nov 13, 2020 CPython 2.7m

pyjet-1.7.0-cp27-cp27m-manylinux1_i686.whl (1.1 MB view details)

Uploaded Nov 13, 2020 CPython 2.7m

pyjet-1.7.0-cp27-cp27m-macosx_10_9_x86_64.whl (311.6 kB view details)

Uploaded Nov 13, 2020 CPython 2.7m macOS 10.9+ x86-64

File details

Details for the file pyjet-1.7.0.tar.gz.

File metadata

Download URL: pyjet-1.7.0.tar.gz
Upload date: Nov 13, 2020
Size: 100.2 kB
Tags: Source
Uploaded using Trusted Publishing? No
Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.0 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.9.0

File hashes

Hashes for pyjet-1.7.0.tar.gz
Algorithm	Hash digest
SHA256	`eca7a10b1dd82be14d6f231768df51a2593be30cb5b61f9a14954583f7d08f9f`
MD5	`e3009d042548bb8c0b783b4ff82d928a`
BLAKE2b-256	`563cd993503e8c74e396a2a09df86c830fe52e46c68ab296e52cde1a6eafce3f`

Algorithm	Hash digest
SHA256	`cf8aa86cbe3ba09d9136ccca420b93ddab3527c05e9044892cb5b9642c7dee0c`
MD5	`36e8d92b5ad301afa76dc543e7c6727e`
BLAKE2b-256	`7e24a974763083d3c6cf45513cacedf5a35847a21c5a56972b85725e397c3f6d`

Algorithm	Hash digest
SHA256	`f865f0270283590f1d0bd3a0fc0b0db861ce0b32ab295a3bc150620672940f3e`
MD5	`46c772c31bc9dfbc01edd52872233d73`
BLAKE2b-256	`7081b84f336d797ba6173d500ab5fb8c321cfcab52be198bf2c7d1a373d4b025`

Algorithm	Hash digest
SHA256	`42c39062791680c4ef247e2e06a6737364c11bed91cbacf21fead2e7819051f4`
MD5	`17e6cc7f3d56a12ba2207304c6a7b944`
BLAKE2b-256	`851ad83f157039e20a7248571e74db9a77149c6743394c108d572759cf9c9a59`

Algorithm	Hash digest
SHA256	`468b66ec2e4a48d9c4f951116f62d3d29f3bfc0e492383f2329e83fedf2f7b66`
MD5	`eba6f2efa3300765b67b11c1114061aa`
BLAKE2b-256	`6208f69a40d992adf27cb0ac302852309b880f61aeb8b65d1f1864e9a4134e22`

Algorithm	Hash digest
SHA256	`de781d51068422405c98b6e5aa738fdc0b63d96f983e332209fcbfa488577645`
MD5	`14582f923db4f148f06dcb9ebc7e7124`
BLAKE2b-256	`373008a54cc4fd0d0911056904295f9c874237246861f9d0d31bdd2398409c76`

Algorithm	Hash digest
SHA256	`b9853d6c403cd59d06a1f0edbc2b7fd80b0a521dbfd9863ae0617390aea778e6`
MD5	`64c3524d13f7e399e9feba6b72c65cee`
BLAKE2b-256	`96d9cdea19c9af61a4c9ecec7fb272cd64c7cd744bf8b33c8309977e7d4b4dfc`

Algorithm	Hash digest
SHA256	`d7e9399a05bec1c72d50ee42d6ab259233341987f3858a27cf39c4039643ae74`
MD5	`cc3e0d7bb1d2e420a226b5b23b14c680`
BLAKE2b-256	`97bd76346e77da93b07211f6208a862fb19bc4ff3b9c5d5649c6a3932d48027f`

Algorithm	Hash digest
SHA256	`be6c325c8d26acc92feef2b417f7b7a68e37d199cb417c314a06c55b84b27089`
MD5	`defb78d5c8a187507eaac01bf9ec11eb`
BLAKE2b-256	`c37f2199347aaf347f2d6697bc1c09894ba25c605e0b6151af926e560b073e30`

Algorithm	Hash digest
SHA256	`b31a6e24a3244a6baf26d7807bcaec2940da2864ae3fa0bf5b8220cb02d2ca0f`
MD5	`541ce57b2c8b3daa036e0cf11fe644df`
BLAKE2b-256	`1363276e5f62889990db9a2955cf4849599d12cbc42d5e33c21d349f6acb7cfc`

Algorithm	Hash digest
SHA256	`aeb214b1a69db485dcc8cceef9d031a2371dd15967f0c66406460dfc1799e890`
MD5	`ebc6f73772930f2dfaf6c6bfa8f94c51`
BLAKE2b-256	`d824ac2e27a013fc41cb26763440a82ebbdba28efc561f4505c1c2e95eabbf87`

Algorithm	Hash digest
SHA256	`04a48e28c766a3d0430f48123d3ad9c492306942f10f90fd54bef5a8af3b8010`
MD5	`7fe39b52b9579b109e9292712a20de54`
BLAKE2b-256	`aff8a20c8e2d0f0eda7602ce0bc989061b71028133273d8fb9fbb850edc3161c`

Algorithm	Hash digest
SHA256	`61ee42c526022bf01e76ceb33dee45710609e0de712e9a7541f061e7cb1e000d`
MD5	`b3c98936a0daa016e750c25d39ae56c8`
BLAKE2b-256	`e3346fd8668d7d83b5cf9a17b9fc954b751e7a6153388ed58769400c4c354396`

Algorithm	Hash digest
SHA256	`80c013bdedae45aee04e43b3b688055752a185f4ff33c8c0e57f14f3ac336c77`
MD5	`f3b507ecf0d8bd7014a603be4dbea624`
BLAKE2b-256	`4e86e4f2034c0320731e70e8a479c15e54d661a6881a8b7ff5c52c0bd4967e5e`

Algorithm	Hash digest
SHA256	`ea7642c3ea0cdd33b0796069d9b6f32c0699ce5f99c36656d8417f9b3da8cceb`
MD5	`178451edf814aee9f2e91a3d23949cf3`
BLAKE2b-256	`b3a765213fe1f515d2afc3399ee57aaa17c4dc7241dde735c607a0ebee676325`

Algorithm	Hash digest
SHA256	`8db7b8fe9133bbcbbc8f52f444c322a9bf63c9e0d088037fd504c57aa74c7b17`
MD5	`b9e92ddd61c97a66b8d27147d31950bc`
BLAKE2b-256	`b4177cea31549e7d0b607789c80b726bccdcd63c2cb0d1539c33eb9718160a1d`

Algorithm	Hash digest
SHA256	`b6aead72530163c3efeaf3bbfedd49fc22885cee6f7bdaa9aa9c603fda2b2330`
MD5	`6f945f916fce868fbbf563110f1ddcb5`
BLAKE2b-256	`b9539f64f6d20f512ca728c5c95edb31eae785f757ec059dfb75066a6b9e13f5`

Algorithm	Hash digest
SHA256	`bcf06906b1452364817107a23252656ace92758ab475d2a34a0776de10a6e32c`
MD5	`1be1140c3bc5a33435eba35866fe35d5`
BLAKE2b-256	`f5f1974ac4b0c781c73c93f41470b3d639a52d74d980951c5532e59da839e709`

Algorithm	Hash digest
SHA256	`4b8f1cc897135a849c7b251dada9e629b9fc804ae389c250a2d936163c69943b`
MD5	`96b53f9f9730826e3ed4e27df4b79222`
BLAKE2b-256	`3ab578de0bed5ce0889564e70fdda4bfb26f90b11cb484fc31961cda04b059a5`

Algorithm	Hash digest
SHA256	`d5b3c22d7691d396654159ec58d34e854290a0c273c9055a7d049306b9e16f55`
MD5	`25719cada22b4f3a2e85432ed78913b5`
BLAKE2b-256	`1d28a0958acaba21feaa1c50f5156c4ff250cb961e106c64154ab33ec02232af`

Algorithm	Hash digest
SHA256	`8c41cfdb4ac39c9f39f073536884e68cb464872b0780f560875e7ceeb7fa33d1`
MD5	`e10809643efa3a6e6e9d2efd31763d27`
BLAKE2b-256	`0d2385508973ac8109fc56bd7d4b4083269f2cbc3a177493749a43602514a1fb`

pyjet 1.7.0

Navigation

Verified details

Maintainers

Unverified details

Project links

Meta

Classifiers

Project description

Strict dependencies

Getting started

Standalone Installation

Using an External FastJet Installation

Note on units

Developing

Project details

Verified details

Maintainers

Unverified details

Project links

Meta

Classifiers

Release history Release notifications | RSS feed

Download files

Source Distribution

Built Distributions

File details

File metadata

File hashes

File details

File metadata

File hashes

File details

File metadata

File hashes

File details

File metadata

File hashes

File details

File metadata

File hashes

File details

File metadata

File hashes

File details

File metadata

File hashes

File details

File metadata

File hashes

File details

File metadata

File hashes

File details

File metadata

File hashes

File details

File metadata

File hashes

File details

File metadata

File hashes

File details

File metadata

File hashes

File details

File metadata

File hashes

File details

File metadata

File hashes

File details

File metadata

File hashes

File details

File metadata

File hashes

File details

File metadata

File hashes

Algorithm	Hash digest
SHA256	`f37b49582091740323fe04f77e421b0b19c7496e0ccf1b502f0eab4ee1a24cf0`
MD5	`c4a9cf110b309b93b40fa8a11a6f7509`
BLAKE2b-256	`de84609b276e280292785cb75a64670adf13dfda2f6e600da6ea14684b781620`

Algorithm	Hash digest
SHA256	`8a9fca6a3280b8d2bd497e041c3a9192a541f1b23c0c323611bcef2b16c83898`
MD5	`2978ff3865ff9c31761edc48ab17efa6`
BLAKE2b-256	`01f96e2a25bab01ce7489532b8fb7a34edba8236d64d748ced67611868606cb5`

Algorithm	Hash digest
SHA256	`ff4497d8f950db80a70673a72f5e8b6ddf20dabd849470478d4fa4d891e436cf`
MD5	`ab64e853a5a9bdaf77599cdb5e88cabb`
BLAKE2b-256	`4a7024169406996e4235c0a1aa97d655933acf4b34bc1d623b2b12ef42351659`

Algorithm	Hash digest
SHA256	`f386726328ebccdaf010589cb09257f022c3f41338698aab6545343788e64a7e`
MD5	`25ce255d8ed2b916042a3c690dbe6919`
BLAKE2b-256	`46ea99b66200e6731bad23d5d3940212dead17c3fe5cb49f3f502568e7c4db09`

Algorithm	Hash digest
SHA256	`169e06472a8dc066f8b4f4e703e401dd9aba789f106d9f5f6af2d08cb6f04450`
MD5	`590b545850f550a1d30c8f8fed1eae88`
BLAKE2b-256	`26cb19e45b43914051329f97b947efc1a75a4c5750792f8597f1f1af34968406`

Algorithm	Hash digest
SHA256	`46af2452f7d2b50e0cb4638e290bdca63000f3424efaa5867267b3e1a7615788`
MD5	`ecc898c73e19ebf9b44e361f19bc39a2`
BLAKE2b-256	`ff0be6f9d3bdc23f8a02fce96e32b784d22fd0938f008ee5256a02bcecb53c43`