From f584b2d712aebdaaf3faf163942cba3e0b7951bc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Lannelongue?= Date: Mon, 30 May 2022 18:57:45 +0100 Subject: [PATCH] Update README --- README.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 3ca1531..027e6c7 100644 --- a/README.md +++ b/README.md @@ -80,5 +80,13 @@ and will create the virtualenv with the required packages, based on `requirement the_shared_directory/GreenAlgorithms4HPC/myCarbonFootprint.sh ``` -## How to update the code without overwriting local changes: -_TBC_ +## How to update the code: +_More elegant solutions welcome! [Discussion here](https://github.com/Llannelongue/GreenAlgorithms4HPC/issues/1)._ + +⚠️ Make sure you have saved your custom version of `cluster_info.yaml` and the module loading step of `GreenAlgorithms_global.py`. + +- `git reset --hard` To remove local changes to files (hence the need for a backup!) +- `git pull` +- Update `cluster_info.yaml` and `GreenAlgorithms_global.py` with the details needed for your cluster. +- `chmod +x myCarbonFootprint.sh` to make it executable again +- Test `myCarbonFootprint.sh`