Skip to main content

GRACE-HPC logo

Docs Status

GRACE-HPC

Green Resource for Assessing Carbon & Energy in HPC

gracehpc is a lightweight Python package designed to enable users and operators of SLURM-based HPC systems to estimate and analyse the carbon footprint of their computational workloads. It calculates and displays energy consumption, Scope 2 (operational) and Scope 3 (embodied) carbon emissions for your jobs ran on the system, using SLURM accounting logs and user-specified parameters.

Documentation

For a complete guide to the methodology, installation, and usage of GRACE-HPC, please visit the Official Documentation here.

How to use it?

The package prioritises user experience, accessibility, and flexibility by offering three usage modes designed to accommodate a wide range of users.

  1. Command-line Interface

The tool can be used directly from the command line of your HPC system with simple commands and a wide range of arguments. Ideal for quick analyses for users more comfortable with a lower-level interface and output.

  1. Python Function Call

The same core engine can be called via a function in a Python Script (.py) or a Jupyter Notebook (.ipynb). This mode is ideal for workflow integration and automation, allowing the tool to be embedded into larger Python applications. It also returns the raw datasets produced by the tool for further exploration and user-led analysis afterwards. If you want flexibility, this is the mode for you.

  1. Interactive Jupyter Interface

A simple, widget-based interface can be launched from a Jupyter Notebook (.ipynb) displaying a rich output containing HTML text boxes and interactive plots. This mode allows users to experiment with different parameters without any coding, visualising interesting plots instantly within a single .ipynb notebook. Ideal for users wanting a higher-level, interactive experience.

Key Features

  • Flexible Job Selection: Specify a date range to process jobs for, individual Job IDs, or both.

  • Job Log Extraction: Extracts and processes job details (such as runtime, resource allocation, and usage) using SLURM's sacct command.

  • Energy Consumption: Calculates energy consumption using both usage data and system energy counters (if available).


  • Scope 3 Emissions: Includes Scope 3 (embodied) emissions estimates for a few HPC systems that have undergone a lifecycle assessment and calculated a per node-hour scope 3 emissions factor (Isambard 3, Isambard-AI, Archer 2).

  • Contextual Equivalents: Results include CO₂e equivalents such as the driving, tree-months and flying to help users interpret and understand the scale of the environmental impact.

  • Rich Output Options: View results in the terminal, export to CSV, load as DataFrames, or display interactively in notebooks with instant plots.

The overall goal of this tool is not to serve as a definitive energy and carbon cluster monitoring tool, but rather to provide accessible estimates that inform and raise awareness about the environmental impact of HPC workloads - promoting more sustainable, carbon-aware practices.

Metadata

Release files for gracehpc 0.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for gracehpc 0.1.0
File Size Uploaded
gracehpc-0.1.0.tar.gz 44.7 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for gracehpc 0.1.0
File Interpreter ABI Platform
gracehpc-0.1.0-py3-none-any.whl Python 3 none any Details

Total release size: 96.9 kB

Release files / gracehpc-0.1.0.tar.gz

Download URL gracehpc-0.1.0.tar.gz
Size 44.7 kB
Tags Source
SHA-256 checksum
How to use checksums
29dd1135d2a9c5ade10c7a07ed0614866dac1291cee5b30357c214219bab16cc
BLAKE2b-256 checksum
How to use checksums
fb96ddcbdb5d81d52cece59de5746664a26a06429729314215f6f94826f90067
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/2.1.3 CPython/3.12.2 Darwin/24.5.0

Release files / gracehpc-0.1.0-py3-none-any.whl

Download URL gracehpc-0.1.0-py3-none-any.whl
Size 52.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
38f400ee87bc3be16d35b343e9111f974b3a3e22d7621c59afd48ad50e824e26
BLAKE2b-256 checksum
How to use checksums
8ea77f81bcc733875c179a6c519518a479109848b605b2533e9cb22f36607c0f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/2.1.3 CPython/3.12.2 Darwin/24.5.0

Release history Release notifications | RSS feed

This release

0.1.0 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page