Skip to main content

HEP analysis components for FAST-HEP workflows.

Project description

fasthep-carpenter

CI PyPI Python Versions Documentation Status Discussions

FAST-HEP

fasthep-carpenter provides common analysis building blocks for FAST-HEP workflows.

It contains reusable High Energy Physics transforms, sources, sinks, and runtime helpers built on top of fasthep-flow.

The Python import namespace is:

import fasthep_carpenter

Scope

fasthep-carpenter is responsible for:

  • ROOT and awkward-array based sources
  • event stream manipulation
  • HEP analysis transforms
  • histogram filling
  • cutflows
  • object selection helpers
  • common CMS/LHC analysis utilities
  • workflow runtime extensions

It is the main “analysis implementation” layer of the FAST-HEP ecosystem.

Relationship to fasthep-flow

fasthep-flow provides:

  • workflow compilation
  • execution planning
  • orchestration
  • registries
  • backend interfaces

fasthep-carpenter provides:

  • concrete analysis operations
  • HEP-specific runtime behaviour
  • physics object manipulation
  • common workflow primitives

In practice, most HEP users will use both packages together.

Recommended companion packages

  • fasthep-flow

    • workflow language and execution engine
  • fasthep-curator

    • dataset inspection
    • schema generation
    • metadata snapshots
  • fasthep-render

    • plotting
    • tables
    • reports
  • fasthep-cli

    • the fasthep command-line interface

Alternatively, install the meta package:

pip install fasthep

Installation

Install directly:

pip install fasthep-carpenter

Development environment:

pixi install
pixi run ci

Minimal example

Example transform registration:

registry:
  transforms:
    define:
      spec: fasthep_carpenter.spec.define_transform:DEFINE_TRANSFORM_SPEC
      impl: fasthep_carpenter.impl.define_transform:run_define_transform

Example workflow snippet:

steps:
  - id: TightMuon
    op: hep.select
    params:
      collection: Muon
      mask: Muon_tightId

Design principles

fasthep-carpenter focuses on:

  • reusable analysis primitives
  • declarative workflows
  • registry-driven extension
  • experiment-agnostic interfaces where possible
  • compatibility with awkward-array based analysis ecosystems

The package intentionally separates workflow orchestration (fasthep-flow) from domain-specific analysis behaviour.

Documentation

Main FAST-HEP documentation:

API documentation for this package:

Repository

Main FAST-HEP repository and project links:

Contributing

Contribution guidelines, development setup, and project-wide documentation are maintained centrally in the main FAST-HEP repository.

Legacy branch

The pre-split prototype implementation is preserved in the legacy branch.

The new main branch contains the split-package architecture.

Status

FAST-HEP is currently in active pre-alpha development.

Interfaces may still evolve rapidly while the package split and stabilization work continues.

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

fasthep_carpenter-2026.6.1.tar.gz (22.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

fasthep_carpenter-2026.6.1-py3-none-any.whl (31.8 kB view details)

Uploaded Python 3

File details

Details for the file fasthep_carpenter-2026.6.1.tar.gz.

File metadata

  • Download URL: fasthep_carpenter-2026.6.1.tar.gz
  • Upload date:
  • Size: 22.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for fasthep_carpenter-2026.6.1.tar.gz
Algorithm Hash digest
SHA256 e91272f761ae64bba03eeb4d9677015c7063051824f180eec603d1be4588e19b
MD5 fbebdf85cece6177cdfdc69680dc72eb
BLAKE2b-256 1383578228bc5110422ac9148833c0cd2f385f3e38d6a004feec38db9f658f98

See more details on using hashes here.

Provenance

The following attestation bundles were made for fasthep_carpenter-2026.6.1.tar.gz:

Publisher: cd.yml on FAST-HEP/fasthep-carpenter

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

File details

Details for the file fasthep_carpenter-2026.6.1-py3-none-any.whl.

File metadata

File hashes

Hashes for fasthep_carpenter-2026.6.1-py3-none-any.whl
Algorithm Hash digest
SHA256 4de777b662a9152e1d97018f21d870aa8b018f07a8f2b727a6d1fcafaa183d74
MD5 736d20961abaa7b588c2ae2017a82ed2
BLAKE2b-256 d460ad677172878a4d277ee70cd9b88c20753dca4fbc52517f4e9e026f0a7003

See more details on using hashes here.

Provenance

The following attestation bundles were made for fasthep_carpenter-2026.6.1-py3-none-any.whl:

Publisher: cd.yml on FAST-HEP/fasthep-carpenter

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 Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page