doc: add release note and improve documentation

Author: tgilon

doc/release_notes.md

@@ -80,6 +80,8 @@
 
 * Use `combine_indicators` instead of `collect_indicators` in the function `summary_benchmark_indicators` ([#797](https://github.com/open-energy-transition/open-tyndp/pull/797)).
 
+* Refactor `clean_projects` script to reduce the redundancy in its outputs ([#804](https://github.com/open-energy-transition/open-tyndp/issues/804)).
+
 
 ## Upcoming PyPSA-Eur Release
 

scripts/cba/clean_projects.py

@@ -16,17 +16,17 @@
 the user can modify existing projects and add new ones.
 
 - Using an existing combination (`project_id`, `bus0`, `bus1`), the user can overwrite any
-field of an existing project with a custom value. Not all fields need to be specified; leaving
-a field empty keeps its existing value.
+  field of an existing project with a custom value. Not all fields need to be specified; leaving
+  a field empty keeps its existing value.
 
-- New projects are added as PINT projects. A new `project_id` must be used, and custom projects are added as links.
+- New projects must use a new `project_id` and are added as PINT links.
 
 **Inputs**
 
 - `data/tyndp_2024_bundle/cba_projects/20250312_export_transmission.xlsx`: Excel file containing CBA transmission projects
 - `data/tyndp_2024_bundle/cba_projects/20250312_export_storage.xlsx`: Excel file containing CBA storage projects (not yet processed)
 - `rules.retrieve_tyndp.output.nodes`: List of nodes defined in the workflow
-- `rules.retrieve_cba_guidelines_reference_projects.output.file`: Overview of the projects included in the reference grid, as defined in the Implementation Guidelines.
+- `rules.retrieve_cba_guidelines_reference_projects.output.file`: Overview of the projects included in the reference grid, as defined in the Implementation Guidelines
 - `data/custom_cba_transmission_projects.csv`: File used to configure custom transmission projects. With it, the user can modify existing projects and add new ones.
 
 **Outputs**
@@ -45,6 +45,8 @@
 
 - `resources/cba/storage_projects.csv`: Empty CSV with columns project_id and project_name (stub implementation)
 
+- `resources/cba/cba_project_methods.csv`: List of the method to apply on projects
+
 """
 
 import logging
@@ -77,15 +79,17 @@ def read_tyndp_electricity_buses(buses_fn: str) -> pd.Index:
 
     Parameters
     ----------
-        - buses_fn (str): Path to "LIST OF NODES.xlsx" from tyndp bundle
+    buses_fn : str
+        Path to "LIST OF NODES.xlsx" from tyndp bundle.
 
     Returns
     -------
-        - buses: Index of electricity buses as used in Open-TYNDP
+    pd.Index
+        Index of electricity buses as used in Open-TYNDP.
 
     See Also
     --------
-        build_tyndp_network.py : build_buses
+    build_tyndp_network.py : build_buses
     """
     buses = pd.Index(
         pd.read_excel(buses_fn)
@@ -148,7 +152,7 @@ def remove_no_capacity(projects: pd.DataFrame) -> pd.DataFrame:
     Returns
     -------
     pd.DataFrame
-        Curated list of projects with a defined capacity
+        Curated list of projects with a defined capacity.
     """
     if projects.empty:
         return projects
@@ -227,7 +231,7 @@ def extract_transmission_projects(
         }
     )
 
-    # Clean the project list by removing unclear border and projects with no capacity
+    # Clean the project list by removing projects with unclear borders or no capacity
     projects = remove_unclear_border(projects, existing_buses)
     projects = remove_no_capacity(projects)
 
@@ -355,7 +359,7 @@ def overwrite_projects(
     new_projects = custom_projects.index.difference(projects.index)
     existing_projects = custom_projects.index.intersection(projects.index)
 
-    # Fill missing values with existing projects
+    # Fill missing values from existing projects
     custom_projects = custom_projects.reindex(columns=projects.columns).fillna(projects)
     custom_projects["is_crossborder"] = (
         custom_projects["is_crossborder"].fillna(True).astype(bool)
@@ -399,8 +403,8 @@ def build_method_assignments(
     guidelines: pd.DataFrame, projects: pd.DataFrame
 ) -> pd.DataFrame:
     """
-    Define the method to apply on a project. The method can be PINT (default) or TOOT and can verify on
-    the planning horizon (2030 or 2040).
+    Determine the CBA assessment method for each project. The method is PINT (default) or TOOT and
+    depends on the planning horizon (2030 or 2040).
 
     Parameters
     ----------
@@ -413,7 +417,6 @@ def build_method_assignments(
     -------
     pd.DataFrame
         List of the method to apply on projects.
-
     """
     guidelines = guidelines.rename(
         columns={
@@ -506,7 +509,7 @@ def build_method_assignments(
 
     # Storage projects
     storage_projects = extract_storage_projects(storage_path, existing_buses)
-    # TODO Add overwrite_projects for storages
+    # TODO Add overwrite_projects for storage projects
     storage_projects.to_csv(snakemake.output.storage_projects, index=False)
 
     # Method definition (PINT / TOOT)

scripts/cba/prepare_project.py

@@ -43,13 +43,12 @@ def load_method(methods_fn: str, project_id: int, planning_horizon: int) -> str:
     project_id : int
         Project reference ID.
     planning_horizon : int
-        Planning horizon
+        Planning horizon.
 
     Returns
     -------
     str
         Method to be used to assess a project at a planning horizon.
-
     """
     methods = pd.read_csv(methods_fn)
     row = methods[