Metadata-Version: 2.1
Name: PyFJCore
Version: 0.1.0
Summary: Python wrapper of FastJet Core functionality with NumPy support
Home-page: https://github.com/pkomiske/PyFJCore
Author: Patrick T. Komiske III
Author-email: pkomiske@mit.edu
License: GPL-3.0
Description: # PyFJCore
        
        Python wrapper of FastJet Core functionality with NumPy support.
        
        ## fjcore README
        
        ```text
        // fjcore -- extracted from FastJet v3.3.4 (http://fastjet.fr)
        //
        // fjcore constitutes a digest of the main FastJet functionality.
        // The files fjcore.hh and fjcore.cc are meant to provide easy access to these 
        // core functions, in the form of single files and without the need of a full 
        // FastJet installation:
        //
        //     g++ main.cc fjcore.cc
        // 
        // with main.cc including fjcore.hh.
        //
        // A fortran interface, fjcorefortran.cc, is also provided. See the example 
        // and the Makefile for instructions.
        //
        // The results are expected to be identical to those obtained by linking to
        // the full FastJet distribution.
        //
        // NOTE THAT, IN ORDER TO MAKE IT POSSIBLE FOR FJCORE AND THE FULL FASTJET
        // TO COEXIST, THE FORMER USES THE "fjcore" NAMESPACE INSTEAD OF "fastjet". 
        //
        // In particular, fjcore provides:
        //
        //   - access to all native pp and ee algorithms, kt, anti-kt, C/A.
        //     For C/A, the NlnN method is available, while anti-kt and kt
        //     are limited to the N^2 one (still the fastest for N < 100k particles)
        //   - access to selectors, for implementing cuts and selections
        //   - access to all functionalities related to pseudojets (e.g. a jet's
        //     structure or user-defined information)
        //
        // Instead, it does NOT provide:
        //
        //   - jet areas functionality
        //   - background estimation
        //   - access to other algorithms via plugins
        //   - interface to CGAL
        //   - fastjet tools, e.g. filters, taggers
        //
        // If these functionalities are needed, the full FastJet installation must be
        // used. The code will be fully compatible, with the sole replacement of the
        // header files and of the fjcore namespace with the fastjet one.
        //
        // fjcore.hh and fjcore.cc are not meant to be human-readable.
        // For documentation, see the full FastJet manual and doxygen at http://fastjet.fr
        //
        // Like FastJet, fjcore is released under the terms of the GNU General Public
        // License version 2 (GPLv2). If you use this code as part of work towards a
        // scientific publication, whether directly or contained within another program
        // (e.g. Delphes, MadGraph, SpartyJet, Rivet, LHC collaboration software frameworks, 
        // etc.), you should include a citation to
        // 
        //   EPJC72(2012)1896 [arXiv:1111.6097] (FastJet User Manual)
        //   and, optionally, Phys.Lett.B641 (2006) 57 [arXiv:hep-ph/0512210]
        //
        //FJSTARTHEADER
        // $Id$
        //
        // Copyright (c) 2005-2020, Matteo Cacciari, Gavin P. Salam and Gregory Soyez
        //
        //----------------------------------------------------------------------
        // This file is part of FastJet (fjcore).
        //
        //  FastJet is free software; you can redistribute it and/or modify
        //  it under the terms of the GNU General Public License as published by
        //  the Free Software Foundation; either version 2 of the License, or
        //  (at your option) any later version.
        //
        //  The algorithms that underlie FastJet have required considerable
        //  development. They are described in the original FastJet paper,
        //  hep-ph/0512210 and in the manual, arXiv:1111.6097. If you use
        //  FastJet as part of work towards a scientific publication, please
        //  quote the version you use and include a citation to the manual and
        //  optionally also to hep-ph/0512210.
        //
        //  FastJet is distributed in the hope that it will be useful,
        //  but WITHOUT ANY WARRANTY; without even the implied warranty of
        //  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
        //  GNU General Public License for more details.
        //
        //  You should have received a copy of the GNU General Public License
        //  along with FastJet. If not, see <http://www.gnu.org/licenses/>.
        //----------------------------------------------------------------------
        //FJENDHEADER
        ```
        
Keywords: fastjet,fjcore,numpy,swig
Platform: UNKNOWN
Requires-Python: >=2.7
Description-Content-Type: text/markdown
