correctionlib 2.6.4__tar.gz → 2.7.0__tar.gz

correctionlib-2.7.0/.github/workflows/ci.yml

@@ -0,0 +1,91 @@
+name: CI
+
+on:
+  workflow_dispatch:
+  pull_request:
+  merge_group:
+  push:
+    branches:
+    - master
+    - main
+    - develop
+
+jobs:
+  pre-commit:
+    name: Format
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        submodules: recursive
+        fetch-depth: 0
+        fetch-tags: true
+    - uses: actions/setup-python@v3
+      with:
+        python-version: 3.12
+    - uses: pre-commit/action@v3.0.0
+      with:
+        extra_args: --hook-stage manual --all-files
+
+  checks:
+    name: Check Python ${{ matrix.python-version }} on ${{ matrix.runs-on }}
+    runs-on: ${{ matrix.runs-on }}
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.12", "3.13"]
+        runs-on: [ubuntu-latest, macos-latest, windows-latest]
+
+        include:
+        - python-version: "3.8"
+          runs-on: ubuntu-latest
+        - python-version: "3.8"
+          runs-on: macos-13
+        - python-version: "3.8"
+          runs-on: windows-latest
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        submodules: recursive
+        fetch-depth: 0
+        fetch-tags: true
+
+    - uses: actions/setup-python@v3
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install package
+      run: python -m pip install .[test]
+
+    - name: Test package
+      run: python -m pytest -ra
+
+  checkroot:
+    name: Check ROOT bindings
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: recursive
+          fetch-depth: 0
+          fetch-tags: true
+
+      - name: Set up Conda
+        uses: conda-incubator/setup-miniconda@v3
+        with:
+          python-version: 3.12
+          miniforge-version: latest
+
+      - name: Install ROOT
+        shell: bash -l {0}
+        run: |
+          mamba install root
+
+      - name: Install package
+        shell: bash -l {0}
+        run: python -m pip install .[test]
+
+      - name: Test package
+        shell: bash -l {0}
+        run: python -m pytest -ra

correctionlib-2.7.0/.github/workflows/wheels.yml

@@ -0,0 +1,76 @@
+name: wheels
+
+on:
+  workflow_dispatch:
+  release:
+    types:
+      - published
+  pull_request:
+    paths:
+      - ".github/workflows/wheels.yml"
+
+jobs:
+  make_sdist:
+    name: Make SDist
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        submodules: recursive
+        fetch-tags: true
+        fetch-depth: 0
+
+    - name: Build SDist
+      run: pipx run build --sdist
+
+    - uses: actions/upload-artifact@v4
+      with:
+        name: artifact-sdist
+        path: dist/*.tar.gz
+
+  build_wheels:
+    name: Wheel on ${{ matrix.os }} (${{ matrix.arch }})
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, ubuntu-24.04-arm, windows-latest, macos-latest]
+        arch: [auto64]
+        include:
+          - os: macos-latest
+            arch: universal2
+
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        submodules: recursive
+        fetch-tags: true
+        fetch-depth: 0
+
+    - uses: pypa/cibuildwheel@v2.23
+      env:
+        CIBW_ARCHS: ${{ matrix.arch }}
+        MACOSX_DEPLOYMENT_TARGET: 10.14
+
+    - name: Upload wheels
+      uses: actions/upload-artifact@v4
+      with:
+        name: artifact-wheel-${{ matrix.os }}-${{ matrix.arch }}
+        path: wheelhouse/*.whl
+
+  pypi-publish:
+    needs: [build_wheels, make_sdist]
+    name: Upload release to PyPI
+    runs-on: ubuntu-latest
+    if: github.event_name == 'release' && github.event.action == 'published'
+    permissions:
+      id-token: write
+    steps:
+    - uses: actions/download-artifact@v4
+      with:
+        path: dist
+        pattern: artifact-*
+        merge-multiple: true
+
+    - name: Publish package distributions to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1

correctionlib-2.7.0/CMakeLists.txt

@@ -0,0 +1,102 @@
+cmake_minimum_required(VERSION 3.11)
+
+if(NOT SKBUILD_PROJECT_VERSION)
+  set(SKBUILD_PROJECT_VERSION "0.0.0")  # provided by scikit-build-core
+endif()
+string(REPLACE "." ";" VERSION_SPLIT ${SKBUILD_PROJECT_VERSION})
+list(GET VERSION_SPLIT 0 SPLIT_VERSION_MAJOR)
+list(GET VERSION_SPLIT 1 SPLIT_VERSION_MINOR)
+
+project(correctionlib VERSION ${SPLIT_VERSION_MAJOR}.${SPLIT_VERSION_MINOR} LANGUAGES CXX)
+
+option(BUILD_DEMO "Build demo program" ON)
+
+set(PKG_INSTALL "correctionlib") ## python package name
+
+include(FetchContent)
+FetchContent_Declare(pybind11
+  SOURCE_DIR ${CMAKE_CURRENT_SOURCE_DIR}/pybind11
+  CMAKE_ARGS "-DBUILD_TESTING=OFF -DPYBIND11_NOPYTHON=ON"
+  )
+FetchContent_MakeAvailable(pybind11)
+
+set(THREADS_PREFER_PTHREAD_FLAG ON)
+find_package(Threads)
+find_package(ZLIB)
+
+
+configure_file(include/version.h.in ${CMAKE_CURRENT_BINARY_DIR}/include/correctionlib_version.h)
+install(FILES ${CMAKE_CURRENT_BINARY_DIR}/include/correctionlib_version.h DESTINATION ${PKG_INSTALL}/include)
+
+
+add_library(correctionlib SHARED src/correction.cc src/formula_ast.cc)
+set_target_properties(correctionlib PROPERTIES PUBLIC_HEADER include/correction.h WINDOWS_EXPORT_ALL_SYMBOLS ON)
+target_include_directories(correctionlib
+  PUBLIC
+    $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include>
+    $<BUILD_INTERFACE:${CMAKE_CURRENT_BINARY_DIR}/include>
+    $<INSTALL_INTERFACE:${PKG_INSTALL}/include>
+  PRIVATE
+    $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/rapidjson/include>
+    $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/cpp-peglib>
+    $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/xxhash>
+    $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/pcg-cpp/include>
+  )
+target_compile_features(correctionlib PUBLIC cxx_std_17)
+if(MSVC)
+  target_compile_options(correctionlib PRIVATE /Zc:__cplusplus /utf-8)
+else()
+  target_compile_options(correctionlib PRIVATE -Wall -Wextra -Wpedantic -Werror)
+endif()
+if(ZLIB_FOUND)
+  target_link_libraries(correctionlib PRIVATE ZLIB::ZLIB)
+endif()
+if(Threads_FOUND AND CMAKE_SYSTEM_NAME STREQUAL "Linux")
+  target_link_libraries(correctionlib PRIVATE Threads::Threads)
+endif()
+install(TARGETS correctionlib
+  EXPORT correctionlib-targets
+  LIBRARY DESTINATION ${PKG_INSTALL}/lib
+  ARCHIVE DESTINATION ${PKG_INSTALL}/lib
+  RUNTIME DESTINATION ${PKG_INSTALL}/lib
+  PUBLIC_HEADER DESTINATION ${PKG_INSTALL}/include
+  )
+
+
+pybind11_add_module(_core MODULE src/python.cc)
+if(MSVC)
+  target_compile_options(_core PRIVATE /W4 /WX)
+else()
+  target_compile_options(_core PRIVATE -Wall -Wextra -Wpedantic -Werror)
+endif()
+target_link_libraries(_core PRIVATE correctionlib)
+set_target_properties(_core PROPERTIES BUILD_WITH_INSTALL_RPATH ON)
+if (APPLE)
+  set_target_properties(_core PROPERTIES INSTALL_NAME_DIR "@rpath" )
+  set_target_properties(_core PROPERTIES INSTALL_RPATH "@loader_path/lib" )
+else (UNIX)
+  set_target_properties(_core PROPERTIES INSTALL_RPATH "\$ORIGIN/lib" )
+endif()
+install(TARGETS _core LIBRARY DESTINATION ${PKG_INSTALL})
+
+
+add_executable(demo src/demo.cc)
+target_link_libraries(demo PRIVATE correctionlib)
+if(NOT BUILD_DEMO)
+  set_target_properties(demo PROPERTIES EXCLUDE_FROM_ALL ON)
+endif()
+
+
+install(EXPORT correctionlib-targets FILE correctionlib-targets.cmake DESTINATION ${PKG_INSTALL}/cmake)
+include(CMakePackageConfigHelpers)
+configure_package_config_file(${CMAKE_CURRENT_SOURCE_DIR}/Config.cmake.in
+  "${CMAKE_CURRENT_BINARY_DIR}/correctionlibConfig.cmake"
+  INSTALL_DESTINATION "${PKG_INSTALL}/cmake"
+  NO_SET_AND_CHECK_MACRO NO_CHECK_REQUIRED_COMPONENTS_MACRO
+  )
+write_basic_package_version_file(
+  "${CMAKE_CURRENT_BINARY_DIR}/correctionlibConfigVersion.cmake"
+  VERSION "${correctionlib_VERSION_MAJOR}.${correctionlib_VERSION_MINOR}"
+  COMPATIBILITY AnyNewerVersion
+  )
+install(FILES ${CMAKE_CURRENT_BINARY_DIR}/correctionlibConfig.cmake ${CMAKE_CURRENT_BINARY_DIR}/correctionlibConfigVersion.cmake DESTINATION ${PKG_INSTALL}/cmake)

correctionlib-2.7.0/PKG-INFO

@@ -0,0 +1,147 @@
+Metadata-Version: 2.2
+Name: correctionlib
+Version: 2.7.0
+Summary: A generic correction library
+Author-Email: Nick Smith <nick.smith@cern.ch>
+Maintainer-Email: Nick Smith <nick.smith@cern.ch>
+License: BSD-3-Clause
+Classifier: Topic :: Scientific/Engineering
+Classifier: Intended Audience :: Science/Research
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Development Status :: 5 - Production/Stable
+Project-URL: Homepage, https://github.com/cms-nanoAOD/correctionlib
+Requires-Python: >=3.8
+Requires-Dist: numpy>=1.13.3
+Requires-Dist: typing-extensions; python_version < "3.8"
+Requires-Dist: dataclasses; python_version < "3.7"
+Requires-Dist: pydantic>=2
+Requires-Dist: rich
+Requires-Dist: packaging
+Provides-Extra: test
+Requires-Dist: pytest>=4.6; extra == "test"
+Requires-Dist: scipy; extra == "test"
+Requires-Dist: awkward>=2.2.2; python_version > "3.7" and extra == "test"
+Requires-Dist: awkward<2; python_version <= "3.7" and extra == "test"
+Requires-Dist: dask-awkward>=2024.1.1; python_version > "3.7" and extra == "test"
+Requires-Dist: dask<2025.4.0; python_version > "3.7" and extra == "test"
+Provides-Extra: dev
+Requires-Dist: pytest>=4.6; extra == "dev"
+Requires-Dist: pre-commit; extra == "dev"
+Requires-Dist: mypy; extra == "dev"
+Requires-Dist: uhi; extra == "dev"
+Requires-Dist: awkward>=2; extra == "dev"
+Requires-Dist: dask-awkward; python_version > "3.7" and extra == "dev"
+Provides-Extra: docs
+Requires-Dist: recommonmark>=0.5.0; extra == "docs"
+Requires-Dist: Sphinx>=3.0.0; extra == "docs"
+Requires-Dist: sphinx_copybutton; extra == "docs"
+Requires-Dist: sphinx_rtd_theme>=0.5.0; extra == "docs"
+Requires-Dist: sphinx-jsonschema; extra == "docs"
+Requires-Dist: myst-parser; extra == "docs"
+Requires-Dist: nbsphinx; extra == "docs"
+Provides-Extra: convert
+Requires-Dist: pandas; extra == "convert"
+Requires-Dist: uproot>=4.0.4; extra == "convert"
+Requires-Dist: requests; extra == "convert"
+Requires-Dist: scipy; extra == "convert"
+Description-Content-Type: text/markdown
+
+# correctionlib
+
+[![Actions Status][actions-badge]][actions-link]
+[![Documentation Status][rtd-badge]][rtd-link]
+[![Code style: black][black-badge]][black-link]
+
+[![conda version][conda-badge]][conda-link]
+[![PyPI version][pypi-version]][pypi-link]
+[![PyPI platforms][pypi-platforms]][pypi-link]
+
+[![GitHub Discussion][github-discussions-badge]][github-discussions-link]
+
+## Introduction
+The purpose of this library is to provide a well-structured JSON data format for a
+wide variety of ad-hoc correction factors encountered in a typical HEP analysis and
+a companion evaluation tool suitable for use in C++ and python programs.
+Here we restrict our definition of correction factors to a class of functions with
+scalar inputs that produce a scalar output.
+
+In python, the function signature is:
+
+```python
+def f(*args: str | int | float) -> float:
+    return ...
+```
+
+In C++, the evaluator implements this currently as:
+```cpp
+double Correction::evaluate(const std::vector<std::variant<int, double, std::string>>& values) const;
+```
+
+The supported function classes include:
+
+  * multi-dimensional binned lookups;
+  * binned lookups pointing to multi-argument formulas with a restricted
+    math function set (`exp`, `sqrt`, etc.);
+  * categorical (string or integer enumeration) maps;
+  * input transforms (updating one input value in place); and
+  * compositions of the above.
+
+Each function type is represented by a "node" in a call graph and holds all
+of its parameters in a JSON structure, described by the JSON schema.
+Possible future extension nodes might include weigted sums (which, when composed with
+the others, could represent a BDT) and perhaps simple MLPs.
+
+The tool should provide:
+
+  * standardized, versioned [JSON schemas](https://json-schema.org/);
+  * forward-porting tools (to migrate data written in older schema versions); and
+  * a well-optimized C++ evaluator and python bindings (with numpy vectorization support).
+
+This tool will definitely not provide:
+
+  * support for `TLorentzVector` or other object-type inputs (such tools should be written
+    as a higher-level tool depending on this library as a low-level tool)
+
+Formula support currently includes a mostly-complete subset of the ROOT library `TFormula` class,
+and is implemented in a threadsafe standalone manner. The parsing grammar is formally defined
+and parsed through the use of a header-only [PEG parser library](https://github.com/yhirose/cpp-peglib).
+The supported features mirror CMSSW's [reco::formulaEvaluator](https://github.com/cms-sw/cmssw/pull/11516)
+and fully passes the test suite for that utility with the purposeful exception of the `TMath::` namespace.
+The python bindings may be able to call into [numexpr](https://numexpr.readthedocs.io/en/latest/user_guide.html),
+though, due to the tree-like structure of the corrections, it may prove difficult to exploit vectorization
+at levels other than the entrypoint.
+
+Detailed instructions for installing and using this package are provided in the [documentation][rtd-link].
+
+## Creating new corrections
+
+A demo/tutorial of the features is available in the [documentation][rtd-link] and also available interactively
+on [binder](https://mybinder.org/v2/gh/cms-nanoAOD/correctionlib/HEAD?labpath=binder%2Fcorrectionlib_tutorial.ipynb)
+
+The `correctionlib.schemav2` module provides a helpful framework for defining correction objects
+and `correctionlib.convert` includes select conversion routines for common types. Nodes can be type-checked as they are
+constructed using the [parse_obj](https://pydantic-docs.helpmanual.io/usage/models/#helper-functions)
+class method or by directly constructing them using keyword arguments.
+
+## Developing
+See CONTRIBUTING.md
+
+[actions-badge]:            https://github.com/cms-nanoAOD/correctionlib/workflows/CI/badge.svg
+[actions-link]:             https://github.com/cms-nanoAOD/correctionlib/actions
+[black-badge]:              https://img.shields.io/badge/code%20style-black-000000.svg
+[black-link]:               https://github.com/psf/black
+[conda-badge]:              https://img.shields.io/conda/vn/conda-forge/correctionlib.svg
+[conda-link]:               https://github.com/conda-forge/correctionlib-feedstock
+[github-discussions-badge]: https://img.shields.io/static/v1?label=Discussions&message=Ask&color=blue&logo=github
+[github-discussions-link]:  https://github.com/cms-nanoAOD/correctionlib/discussions
+[gitter-badge]:             https://badges.gitter.im/https://github.com/cms-nanoAOD/correctionlib/community.svg
+[gitter-link]:              https://gitter.im/https://github.com/cms-nanoAOD/correctionlib/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge
+[pypi-link]:                https://pypi.org/project/correctionlib/
+[pypi-platforms]:           https://img.shields.io/pypi/pyversions/correctionlib
+[pypi-version]:             https://badge.fury.io/py/correctionlib.svg
+[rtd-badge]:                https://github.com/cms-nanoAOD/correctionlib/actions/workflows/docs.yml/badge.svg
+[rtd-link]:                 https://cms-nanoAOD.github.io/correctionlib/

correctionlib-2.7.0/docs/correctionlib_tutorial.ipynb

@@ -0,0 +1 @@
+../binder/correctionlib_tutorial.ipynb