Skip to main content

Rendering sinks and style helpers for FAST-HEP workflows.

Project description

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.

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_render-2026.5.0.tar.gz (23.2 kB view details)

Uploaded Source

Built Distribution

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

fasthep_render-2026.5.0-py3-none-any.whl (37.5 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for fasthep_render-2026.5.0.tar.gz
Algorithm Hash digest
SHA256 c23cc48705905d2f80c3afeae3b0be5d73028aef0e02c29627f9b7a0d159faca
MD5 3ab3877d1446f28a289120574cd06606
BLAKE2b-256 44b05ea7ee1d1efa696db5f16dc07d9ff2f63d0e411b2d499e4fe9a695f07067

See more details on using hashes here.

Provenance

The following attestation bundles were made for fasthep_render-2026.5.0.tar.gz:

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

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_render-2026.5.0-py3-none-any.whl.

File metadata

File hashes

Hashes for fasthep_render-2026.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c2f98e2c77e011696bacfa6a903b2fdf0dbac626737a4ebef365acf80ca7bfe4
MD5 4880c2143a6277cb335cf5054f85bae7
BLAKE2b-256 09d87bd1ccfb28032c276bb8c33b24a3b9aaef0f7fb796a36df58c330267848a

See more details on using hashes here.

Provenance

The following attestation bundles were made for fasthep_render-2026.5.0-py3-none-any.whl:

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

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