llnl-hatchet

library2026.1.0pypypi✓ verified 84d ago

A Python library for analyzing hierarchical performance data, such as HPCToolkit, Caliper, and TAU profiles. Current version 2026.1.0. Released periodically.

devops

pip install llnl-hatchet

github ↗homepage ↗

INSTALL

IMPORT

SIG · LLNL-HATCHET

llnl-hatchet

devopspythonv2026.1.0

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

GraphFrame

✓ from hatchet import GraphFrame

✗ import hatchet hatchet.GraphFrame()

Direct from hatchet is correct; submodules like hatchet.graphframe are not public API

Load a HPCToolkit OTF2 profile into a GraphFrame

from hatchet import GraphFrame import os gf = GraphFrame.from_hpctoolkit_otf2('path/to/profile.otf2') if os.path.exists('path/to/profile.otf2') else None print(gf)

Debug

Known issues

breakingThe 'from_caliper' reader was removed in 2025.0.0; use 'from_caliper2' instead.

fix

Replace 'gf = GraphFrame.from_caliper(...)' with 'gf = GraphFrame.from_caliper2(...)'

affects: >=2025.0.0

breakingThe 'query' method now returns a DataFrame instead of a list of dicts. Iterating directly over results will break.

fix

Use 'result.to_dict('records')' if you need the old list-of-dicts format.

affects: >=2024.6.0

deprecated'GraphFrame.inc_metrics' and 'GraphFrame.exc_metrics' are deprecated in favor of 'metrics' attribute.

fix

Access 'gf.metrics' instead of 'gf.inc_metrics' or 'gf.exc_metrics'.

affects: >=2025.1.0

gotchaWhen using 'filter()', the returned GraphFrame is a new object; modifying the original does not affect the filtered copy.

fix

Assign the result to a new variable: 'gf_filtered = gf.filter(...)'

affects: all

gotchaThe tree visualizer ('print_tree') may fail for very large graphs unless 'max_depth' and 'max_width' are set.

fix

Use 'print_tree(max_depth=5, max_width=10)' to limit output.

affects: all

Errors

Common errors & fixes

ModuleNotFoundError: No module named 'hatchet'

The import name is 'hatchet' but the PyPI package is 'llnl-hatchet'. People install the wrong package.

fix

Run 'pip install llnl-hatchet' (not 'pip install hatchet').

TypeError: from_hpctoolkit_otf2() missing 1 required positional argument: 'path'

The method 'from_hpctoolkit_otf2' expects a path string, not a directory or file handle.

fix

Provide a valid file path: 'GraphFrame.from_hpctoolkit_otf2("myprofile.otf2")'

AttributeError: 'GraphFrame' object has no attribute 'inc_metrics'

The 'inc_metrics' attribute was deprecated and removed in newer versions.

fix

Use 'gf.metrics' instead.

Upgrade

Version history

2026.1.0latest on PyPI · released Mar 7, 2026

Audit

Dependencies

pandasrequiredData manipulation for frames/tables

matplotlibrequiredPlotting capabilities

h5pyoptionalReading HDF5 trace files

Agent activity

3 hits · last 30 days

node

Amazon

Resources

githubhttps://github.com/llnl/hatchet ↗

homepagehttps://github.com/llnl/hatchet ↗