Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/scikit-hep/fastjet
Jet-finding in the Scikit-HEP ecosystem.
https://github.com/scikit-hep/fastjet
hep high-energy-physics jets particle-physics python scikit-hep
Last synced: about 2 months ago
JSON representation
Jet-finding in the Scikit-HEP ecosystem.
- Host: GitHub
- URL: https://github.com/scikit-hep/fastjet
- Owner: scikit-hep
- License: bsd-3-clause
- Created: 2021-04-15T14:27:36.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-05-15T13:38:53.000Z (about 2 months ago)
- Last Synced: 2024-05-16T03:02:17.356Z (about 2 months ago)
- Topics: hep, high-energy-physics, jets, particle-physics, python, scikit-hep
- Language: Python
- Homepage: https://fastjet.readthedocs.io
- Size: 535 KB
- Stars: 19
- Watchers: 12
- Forks: 11
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
Lists
- awesome-hep - fastjet - hep/pyjet)) (Python / Event generation)
README
[![Actions Status][actions-badge]][actions-link]
[![cirrus-ci Status][cirrus-ci-badge]][cirrus-ci-link]
[![PyPI version][pypi-version]][pypi-link]
[![Conda-Forge][conda-badge]][conda-link]
[![PyPI platforms][pypi-platforms]][pypi-link]
[![GitHub Discussion][github-discussions-badge]][github-discussions-link]
[![Scikit-HEP][sk-badge]](https://scikit-hep.org/)
[actions-badge]: https://github.com/scikit-hep/fastjet/workflows/CI/badge.svg
[actions-link]: https://github.com/scikit-hep/fastjet/actions
[cirrus-ci-badge]: https://api.cirrus-ci.com/github/scikit-hep/fastjet.svg?branch=main
[cirrus-ci-link]: https://cirrus-ci.com/github/scikit-hep/fastjet
[conda-badge]: https://img.shields.io/conda/vn/conda-forge/fastjet
[conda-link]: https://github.com/conda-forge/fastjet-feedstock
[github-discussions-badge]: https://img.shields.io/static/v1?label=Discussions&message=Ask&color=blue&logo=github
[github-discussions-link]: https://github.com/scikit-hep/fastjet/discussions
[pypi-link]: https://pypi.org/project/fastjet/
[pypi-platforms]: https://img.shields.io/pypi/pyversions/fastjet
[pypi-version]: https://badge.fury.io/py/fastjet.svg
[rtd-badge]: https://readthedocs.org/projects/fastjet/badge/?version=latest
[rtd-link]: https://fastjet.readthedocs.io/en/latest/?badge=latest
[sk-badge]: https://scikit-hep.org/assets/images/Scikit--HEP-Project-blue.svg
Official FastJet bindings to Python and Awkward Array.
Main features of Fastjet:
* Contains Vectorized, Out-of-core Vectorized (dask), as well as Non-Vectorized interface for Fastjet.
* Compiled against the complete Fastjet library in C++.
* Has Awkward Array, Vector, and optionally Dask as dependencies.
* Provides the functionality to cluster multiple events at a time.
* Input data can be in any coordinate system.
# Installation
The package can be installed from PyPI using the following command:
``` bash
python -m pip install fastjet
```
# Tutorial
For a tutorial please look at the tutorial section of readthedocs page of this package.
# Installation For Developers
Clone this repository recursively to get the dependencies.
```
git clone --recursive https://github.com/scikit-hep/fastjet.git
```
## Build dependencies
There are still external build-time dependencies for the C++ components of `fastjet` that need to be installed on the build machine.
To install the build-time dependencies run the following installation commands for your respective operating system:
### Debian/Ubuntu
``` bash
sudo apt-get update && sudo apt-get install -y libboost-dev libmpfr-dev libgmp-dev swig autoconf libtool
```
## Build and install
Then you can build it using the following command:
``` bash
python -m pip install '.[test]'
```