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.6.1.tar.gz (23.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_render-2026.6.1-py3-none-any.whl (34.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: fasthep_render-2026.6.1.tar.gz
  • Upload date:
  • Size: 23.1 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.6.1.tar.gz
Algorithm Hash digest
SHA256 de410670e366096b068bf3f16cdc4db90cf3bb0d6554853784d5d0c41e11cc89
MD5 0e541ca65d177a9734153b55961a3e88
BLAKE2b-256 15e05cb8520746db1d375e1b5360b74e7a3b512415002f4dff890f40d9fcbd4d

See more details on using hashes here.

Provenance

The following attestation bundles were made for fasthep_render-2026.6.1.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.6.1-py3-none-any.whl.

File metadata

File hashes

Hashes for fasthep_render-2026.6.1-py3-none-any.whl
Algorithm Hash digest
SHA256 6434f7298a64c8abcdb718ecc39f1c3be43374a428d4a9ed8473409328762489
MD5 6b4323331c93a03442eae5a2bcb8cd57
BLAKE2b-256 a0d2a938dfd20cb9715b211a8f873443845d4da4bf8adea271bdabd9f69fe842

See more details on using hashes here.

Provenance

The following attestation bundles were made for fasthep_render-2026.6.1-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