feat: modify copy commit processing rule

Snakefile

@@ -1,5 +1,6 @@
 from os.path import exists
 from shutil import copyfile, move
+from scripts.helpers import get_last_commit_message
 
 from snakemake.remote.HTTP import RemoteProvider as HTTPRemoteProvider
 
@@ -19,6 +20,9 @@ SDIR = config["summary_dir"] + config["run"]
 RDIR = config["results_dir"] + config["run"]
 CDIR = config["costs_dir"]
 
+config.update({"git_commit": get_last_commit_message(".")})
+config.update({"submodule_commit": get_last_commit_message("./pypsa-earth")})
+
 CUTOUTS_PATH = (
     "cutouts/cutout-2013-era5-tutorial.nc"
     if config["tutorial"]
@@ -411,15 +415,6 @@ rule copy_config:
         "scripts/copy_config.py"
 
 
-rule copy_commit:
-    output:
-        SDIR + "/commit_info.txt",
-    shell:
-        """
-        git log -n 1 --pretty=format:"Commit: %H%nAuthor: %an <%ae>%nDate: %ad%nMessage: %s" > {output}
-        """
-
-
 rule solve_network:
     input:
         overrides="data/override_component_attrs",
@@ -429,7 +424,6 @@ rule solve_network:
         + "/prenetworks/elec_s{simpl}_{clusters}_ec_l{ll}_{opts}_{sopts}_{planning_horizons}_{discountrate}_{demand}_{h2export}export.nc",
         costs=CDIR + "costs_{planning_horizons}.csv",
         configs=SDIR + "/configs/config.yaml",  # included to trigger copy_config rule
-        commit=SDIR + "/commit_info.txt",
     output:
         RDIR
         + "/postnetworks/elec_s{simpl}_{clusters}_ec_l{ll}_{opts}_{sopts}_{planning_horizons}_{discountrate}_{demand}_{h2export}export.nc",

scripts/helpers.py

@@ -2,6 +2,7 @@
 import logging
 import os
 import shutil
+import subprocess
 import zipfile
 from pathlib import Path
 
@@ -565,3 +566,27 @@ def locate_bus(
         return gdf_co[gdf_co.geometry == min(gdf_co.geometry, key=(point.distance))][
             col
         ].item()  # looks for closest one shape=node
+
+
+def get_last_commit_message(path):
+    """
+    Function to get the last PyPSA-Earth Git commit message
+    Returns
+    -------
+    result : string
+    """
+    _logger = logging.getLogger(__name__)
+    try:
+        last_commit_message = (
+            subprocess.check_output(
+                ["git", "log", "-n", "1", "--pretty=format:%H %s"],
+                cwd=path,
+                stderr=subprocess.STDOUT,
+            )
+            .decode()
+            .strip()
+        )
+        return last_commit_message
+    except subprocess.CalledProcessError as e:
+        _logger.warning(f"Error executing Git: {e}")
+        return None

scripts/solve_network.py

@@ -481,11 +481,11 @@ def add_existing(n):
         snakemake = mock_snakemake(
             "solve_network",
             simpl="",
-            clusters="12",
+            clusters="4",
             ll="c1.0",
             opts="Co2L",
             planning_horizons="2030",
-            sopts="24H",
+            sopts="144H",
             discountrate=0.071,
             demand="DF",
             h2export="120",
@@ -539,6 +539,7 @@ def add_existing(n):
             solver_logfile=snakemake.log.solver,
         )
 
+        n.meta = dict(snakemake.config, **dict(wildcards=dict(snakemake.wildcards)))
         n.export_to_netcdf(snakemake.output[0])
 
     logger.info("Maximum memory usage: {}".format(mem.mem_usage))