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.5.0.tar.gz (18.1 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.5.0-py3-none-any.whl (29.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: fasthep_carpenter-2026.5.0.tar.gz
  • Upload date:
  • Size: 18.1 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.5.0.tar.gz
Algorithm Hash digest
SHA256 340980c97aca57b7acf3b5ef7e675eb10bc2b6d2462387680468324eb9968ea1
MD5 a4bcf4a400cf3a18fd4bebd5bb28a325
BLAKE2b-256 31e3d922dd5e440a1d6b54e4e9fb38cc1cbe1eb98dc2ede3ce745df19e5a84c3

See more details on using hashes here.

Provenance

The following attestation bundles were made for fasthep_carpenter-2026.5.0.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.5.0-py3-none-any.whl.

File metadata

File hashes

Hashes for fasthep_carpenter-2026.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f46ba8042ca1797b0eb395482f08f584560f38475bcb0bf46b76e55dfcd3a0b8
MD5 36e593edce18f2b997e5d008278c8a4a
BLAKE2b-256 fa2d1d3101a0c5f26e25f3c42386bddb575e5641ec2248b96536bfa7e6f7c241

See more details on using hashes here.

Provenance

The following attestation bundles were made for fasthep_carpenter-2026.5.0-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