Skip to content

FAST-HEP/fasthep

Repository files navigation

fasthep

NOTE: New alpha release of the rewrite is coming soon, please wait with any contributions.

CI PyPI Python Versions Documentation Status Discussions

FAST-HEP

fasthep is the meta package for the FAST-HEP ecosystem.

It provides curated installation profiles for compatible FAST-HEP packages and acts as the primary user-facing installation entry point.

What is FAST-HEP?

FAST-HEP is a modular ecosystem for declarative High Energy Physics workflows.

The ecosystem is split into focused packages:

  • fasthep-flow

    • workflow compilation and orchestration
  • fasthep-carpenter

    • analysis transforms and histogramming
  • fasthep-curator

    • dataset inspection and validation
  • fasthep-render

    • plotting and report generation
  • fasthep-cli

    • unified command-line interface
  • fasthep-toolbench

    • shared utilities and UX helpers
  • fasthep-workshop

    • examples and tutorials

The goal is to keep:

  • workflow orchestration
  • analysis logic
  • rendering
  • metadata handling
  • user tooling

cleanly separated and independently evolvable.

Installation profiles

fasthep provides optional dependency groups for different usage profiles.

Basic workflow tools

Installs:

  • fasthep-flow
  • fasthep-cli
pip install "fasthep[basic]"

HEP analysis stack

Installs:

  • fasthep-flow
  • fasthep-cli
  • fasthep-curator
  • fasthep-carpenter
  • fasthep-render
pip install "fasthep[hep]"

Full ecosystem

Installs:

  • all HEP analysis packages
  • shared utilities
pip install "fasthep[full]"

Workshop/tutorial environment

Installs workshop examples and tutorial material.

pip install "fasthep[workshop]"

Verified compatibility bundles

The purpose of the fasthep meta package is to provide:

  • known-good package combinations
  • coordinated ecosystem releases
  • compatibility-tested dependency sets

Individual FAST-HEP packages evolve independently.

The fasthep meta package is intended to represent a verified integration layer across the ecosystem.

Development status

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

Some optional dependencies currently use Git-based installation while packages are being split and published independently.

These direct references are temporary and will be replaced with standard PyPI version pins once the ecosystem stabilizes.

Development environment

Using Pixi:

pixi install
pixi run ci

Documentation

Main FAST-HEP documentation:

Package/API documentation:

Repository

Main project repository:

Contributing

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

Release model

FAST-HEP packages are released independently.

The fasthep meta package is used to:

  • aggregate compatible package sets
  • verify ecosystem integration
  • provide stable installation profiles

This separation allows:

  • faster iteration on individual packages
  • coordinated compatibility releases
  • gradual ecosystem stabilization

Status

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

Interfaces, dependency layouts, and installation profiles may evolve rapidly while the ecosystem stabilizes.

About

A meta package for the FAST-HEP toolkit

Resources

License

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages