Getting started

FAST-HEP is distributed as a collection of modular packages.

The recommended entry point is the fasthep meta package, which provides curated installation profiles for different use cases.

Warning

The FAST-HEP ecosystem is currently undergoing a major rewrite and alpha-stage reorganisation.

Not all packages are available on PyPI yet, and some installation details may change while the ecosystem stabilises.

We will try to keep the main installation entry points stable for their intended use cases.

HEP installation#

Recommended for most HEP users.

Includes:

pip install "fasthep[hep]"

This is expected to become the standard installation profile for typical HEP analyses.

Full installation#

Installs the complete FAST-HEP ecosystem and optional tooling.

pip install "fasthep[full]"

This profile is mainly intended for:

Minimal installation#

Installs only the core workflow tooling.

pip install "fasthep[minimal]"

This profile is intended for:

Additional functionality can then be added incrementally through individual packages and profiles.

Workshop installation#

The workshop repository contains:

Repository:

The workshop examples are currently expected to evolve alongside the alpha ecosystem.

Development workspace#

Contributors working across multiple packages should use:

The development workspace provides:

Next steps#

For most users, the best starting point is the workshop material and runnable examples.

Recommended path:

  1. Explore the Tutorials
  2. Run examples from:
  3. Read:
  4. Explore package-specific documentation:
  5. Learn how analyses are structured:

Optional deeper reading:

On this page