Skip to content

FAST-HEP/fasthep-render

Repository files navigation

fasthep-render

CI PyPI Python Versions Documentation Status Discussions

FAST-HEP

fasthep-render provides plotting, table rendering, reporting, and visualization utilities for FAST-HEP workflows.

The Python import namespace is:

import fasthep_render

Scope

fasthep-render is responsible for:

  • histogram rendering
  • cutflow tables
  • report generation
  • plotting backends
  • rendering registries
  • artifact formatting
  • summary visualizations
  • workflow diagnostics output

It is the presentation and reporting layer of the FAST-HEP ecosystem.

Relationship to fasthep-flow

fasthep-flow provides:

  • workflow compilation
  • orchestration
  • execution planning
  • backend interfaces

fasthep-render provides:

  • visualization
  • report generation
  • artifact formatting
  • plotting implementations
  • rendering specifications

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

Recommended companion packages

  • fasthep-flow

    • workflow language and execution engine
  • fasthep-carpenter

    • HEP analysis transforms
    • histogramming
    • event processing
  • fasthep-curator

    • dataset inspection
    • validation
    • metadata generation
  • fasthep-cli

    • the unified fasthep command-line interface

Alternatively, install the meta package:

pip install fasthep

Installation

Install directly:

pip install fasthep-render

Development environment:

pixi install
pixi run ci

Minimal example

Example render specification:

render:
  NumberOfJets:
    renderer: histogram
    style:
      title: Jet multiplicity
      x_label: Number of jets
      y_label: Events

Example Python usage:

from fasthep_render.api import render_artifact

render_artifact(
    artifact="results/NumberOfJets.pkl",
    spec="render_specs/render_NumberOfJets.yaml",
    output="results/NumberOfJets.png",
)

Design principles

fasthep-render focuses on:

  • declarative rendering
  • reusable render specifications
  • backend-independent visualization
  • registry-driven extensibility
  • reproducible reports
  • publication-oriented outputs

The package intentionally separates rendering and presentation concerns from workflow execution and analysis logic.

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

Earlier rendering implementations existed inside the monolithic prototype repositories.

The current repository contains the standalone split-package rendering layer.

Status

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

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

About

Contains plot, table, histogram, and report renderers

Resources

License

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages