Move config dump in n.meta to own key

doc/release_notes.rst

@@ -9,6 +9,9 @@ Release Notes
 Upcoming Release
 ================
 
+* The Snakemake config is now stored in `n.meta["snakemake_config"]` instead of
+  overwriting the entire `n.meta` to allow for additional metadata fields to be set.
+
 * Fixed `AttributeError` in `prepare_sector_network.py` when running sector-coupled
   PyPSA-Eur with only one country and cluster. 
   (https://github.com/PyPSA/pypsa-eur/pull/1835)

scripts/add_brownfield.py

@@ -372,7 +372,9 @@ def update_dynamic_ptes_capacity(
 
     disable_grid_expansion_if_limit_hit(n)
 
-    n.meta = dict(snakemake.config, **dict(wildcards=dict(snakemake.wildcards)))
+    n.meta["snakemake_config"] = dict(
+        snakemake.config, **dict(wildcards=dict(snakemake.wildcards))
+    )
 
     sanitize_custom_columns(n)
     sanitize_carriers(n, snakemake.config)

scripts/add_electricity.py

@@ -1290,5 +1290,7 @@ def attach_stores(
     if "location" in n.buses:
         sanitize_locations(n)
 
-    n.meta = dict(snakemake.config, **dict(wildcards=dict(snakemake.wildcards)))
+    n.meta["snakemake_config"] = dict(
+        snakemake.config, **dict(wildcards=dict(snakemake.wildcards))
+    )
     n.export_to_netcdf(snakemake.output[0])

scripts/add_existing_baseyear.py

@@ -801,7 +801,9 @@ def add_heating_capacities_installed_before_baseyear(
     if options.get("cluster_heat_buses", False):
         cluster_heat_buses(n)
 
-    n.meta = dict(snakemake.config, **dict(wildcards=dict(snakemake.wildcards)))
+    n.meta["snakemake_config"] = dict(
+        snakemake.config, **dict(wildcards=dict(snakemake.wildcards))
+    )
 
     sanitize_custom_columns(n)
     sanitize_carriers(n, snakemake.config)

scripts/base_network.py

@@ -1644,7 +1644,7 @@ def build_admin_shapes(
     )
 
     # Export network
-    n.meta = snakemake.config
+    n.meta["snakemake_config"] = snakemake.config
     n.export_to_netcdf(snakemake.output.base_network)
 
     # Export shapes

scripts/prepare_network.py

@@ -364,5 +364,7 @@ def set_line_nom_max(
         only_crossborder = snakemake.params.autarky["by_country"]
         enforce_autarky(n, only_crossborder=only_crossborder)
 
-    n.meta = dict(snakemake.config, **dict(wildcards=dict(snakemake.wildcards)))
+    n.meta["snakemake_config"] = dict(
+        snakemake.config, **dict(wildcards=dict(snakemake.wildcards))
+    )
     n.export_to_netcdf(snakemake.output[0])

scripts/prepare_perfect_foresight.py

@@ -673,7 +673,9 @@ def update_heat_pump_efficiency(n: pypsa.Network, years: list[int]) -> None:
     )
 
     # update meta
-    n.meta = dict(snakemake.config, **dict(wildcards=dict(snakemake.wildcards)))
+    n.meta["snakemake_config"] = dict(
+        snakemake.config, **dict(wildcards=dict(snakemake.wildcards))
+    )
 
     # update heat pump efficiency
     update_heat_pump_efficiency(n=n, years=years)

scripts/prepare_sector_network.py

@@ -6498,7 +6498,9 @@ def add_import_options(
         n, snakemake.params["adjustments"], investment_year
     )
 
-    n.meta = dict(snakemake.config, **dict(wildcards=dict(snakemake.wildcards)))
+    n.meta["snakemake_config"] = dict(
+        snakemake.config, **dict(wildcards=dict(snakemake.wildcards))
+    )
 
     sanitize_carriers(n, snakemake.config)
     sanitize_locations(n)

scripts/simplify_network.py

@@ -495,7 +495,9 @@ def remove_converters(n: pypsa.Network) -> pypsa.Network:
         clustered_regions.to_file(snakemake.output[which])
         # append_bus_shapes(n, clustered_regions, type=which.split("_")[1])
 
-    n.meta = dict(snakemake.config, **dict(wildcards=dict(snakemake.wildcards)))
+    n.meta["snakemake_config"] = dict(
+        snakemake.config, **dict(wildcards=dict(snakemake.wildcards))
+    )
     n.export_to_netcdf(snakemake.output.network)
 
     logger.info(

scripts/solve_network.py

@@ -1436,7 +1436,9 @@ def solve_network(
 
     logger.info(f"Maximum memory usage: {mem.mem_usage}")
 
-    n.meta = dict(snakemake.config, **dict(wildcards=dict(snakemake.wildcards)))
+    n.meta["snakemake_config"] = dict(
+        snakemake.config, **dict(wildcards=dict(snakemake.wildcards))
+    )
     n.export_to_netcdf(snakemake.output.network)
 
     with open(snakemake.output.config, "w") as file:

scripts/solve_operations_network.py

@@ -55,5 +55,7 @@
         rule_name=snakemake.rule,
     )
 
-    n.meta = dict(snakemake.config, **dict(wildcards=dict(snakemake.wildcards)))
+    n.meta["snakemake_config"] = dict(
+        snakemake.config, **dict(wildcards=dict(snakemake.wildcards))
+    )
     n.export_to_netcdf(snakemake.output[0])