Skip to content

Latest commit

 

History

History
34 lines (25 loc) · 1.62 KB

README.md

File metadata and controls

34 lines (25 loc) · 1.62 KB

Documentation index

Back to the main README

Getting started

Page Read it to...
Installation Install treecript with Singularity/Apptainer, pip (venv) or Conda.
Standalone collector binary Run execution-metrics-collector without Python: download, build with Docker or Apptainer/Singularity, check HPC compatibility.
Usage and CPU datasets Collect metrics, plot charts, find a CPU TDP and estimate energy consumption.

Reference

Page Read it to...
Output files and metrics Understand the files and columns generated by each collection run.
RO-Crate representation See how results are described in generated RO-Crates.
Legacy scripts Look up the old Bash tools (unmaintained).

Examples

Location Content
onboarding/ Walk-through of a first installation and measurement, with generated charts.
sample-work-to-measure/ Scripts that run sample workloads to measure.
sample-series/ Example metrics of a real workflow execution.
sample-charts/ Example charts produced by plotGraph.

Suggested reading order

  1. Installation (or the standalone binary if you only need to collect).
  2. Usage for the typical collect → plot → aggregate workflow.
  3. Metrics to interpret the results.