From 5fb10e072265b2b3dd6454c8f911b10b201a5a3f Mon Sep 17 00:00:00 2001
From: Pedram Bakh <56321501+PedramBakh@users.noreply.github.com>
Date: Fri, 13 Sep 2024 16:12:33 +0200
Subject: [PATCH] Add powermetrics guide for apple silicon

---
 docs/index.md | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/docs/index.md b/docs/index.md
index 364b6d0..41e2896 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -46,3 +46,12 @@ This ensures that for Slurm we only fetch GPU devices associated with the curren
 If this fails we measure all available GPUs.
 
 - NVML cannot find processes for containers spawned without `--pid=host`. This affects the `device_by_pid` parameter and means that it will never find any active processes for GPUs in affected containers.
+
+## Running **carbontracker** on Apple Silicon
+
+- **carbontracker** is compatible with Apple Silicon on MacOS using `powermetrics` to get power consumption data.
+- `powermetrics` requires root access to run. This can be done by adding `your_username ALL=(ALL) NOPASSWD: /usr/bin/powermetrics` to `/etc/sudoers` (replace `your_username` with your actual username):
+```
+echo "your_username ALL=(ALL) NOPASSWD: /usr/bin/powermetrics" | sudo tee -a /etc/sudoers
+```
+- Alternatively, one can run **carbontracker** with root privileges.
\ No newline at end of file