Metadata-Version: 2.4
Name: fasthep-workshop
Version: 2026.6.1
Summary: FAST-HEP workshop examples and analysis-style extension package.
Author: FAST-HEP contributors
License-File: LICENSE
Requires-Python: >=3.11
Requires-Dist: awkward
Requires-Dist: fasthep-carpenter==2026.06.1
Requires-Dist: fasthep-curator==2026.06.1
Requires-Dist: fasthep-flow==2026.06.1
Requires-Dist: fasthep-render==2026.06.1
Requires-Dist: numpy
Provides-Extra: docs
Requires-Dist: myst-parser; extra == 'docs'
Requires-Dist: pydata-sphinx-theme; extra == 'docs'
Requires-Dist: sphinx; extra == 'docs'
Requires-Dist: sphinx-copybutton; extra == 'docs'
Requires-Dist: sphinx-design; extra == 'docs'
Requires-Dist: sphinxcontrib-mermaid; extra == 'docs'
Provides-Extra: test
Requires-Dist: pytest; extra == 'test'
Description-Content-Type: text/markdown

# fasthep-workshop

`fasthep-workshop` is the home for FAST-HEP tutorials, examples, regression workflows, public validation workflows, and the first lightweight analysis-repository template.

It is also a lightweight installable analysis-example package. Its import namespace is `fasthep_workshop`, and package-owned registry/profile resources demonstrate how an analysis repository can contribute custom components without relying on fragile `scripts.*` imports.

## Install

Basic workflow tools:

```bash
pip install fasthep-flow fasthep-cli
```

HEP analysis workflows:

```bash
pip install fasthep-flow fasthep-carpenter fasthep-curator fasthep-render fasthep-cli fasthep-workshop
```

Later this should become:

```bash
pip install "fasthep[hep]"
```

## Run Examples

Tutorial examples are intended for users and docs. Testing examples are internal
validation workflows for CI, smoke tests, and package integration checks.

Compile the Zmumu tutorial:

```bash
fasthep compile examples/CMS/Zmumu/author.yaml --outdir build/Zmumu
```

Run the CI-friendly runtime smoke workflow:

```bash
fasthep run examples/testing/runtime-smoke/author.yaml --outdir build/testing/runtime-smoke
```

Compile the generated-data ROOT split package validation workflow:

```bash
python scripts/ci/make_testing_data.py
fasthep compile examples/testing/split-packages/author.yaml --outdir build/testing/split-packages
```

Outputs appear under the selected `build/...` directory. Compiler products are written under `compile/`, graph files under `graph/`, render metadata under `render/`, structured reports under `reports/`, user-facing files under `artifacts/`, and backend/runtime diagnostics under `debug/`.

## CI Role

These examples are intended as public golden-path validation workflows. Public CI should run parse/compile smoke checks and small runtime examples. CERN GitLab can add private-data and heavier validation workflows without making private data required here.
