Merge pull request #169 from The-Strategy-Unit/track-centre-in-output-file

now the model region and centre are updated in the output file automa…

Closes #166

Author: morganle-48

data/Renal_Modelling_Input_File - Fictional Region.xlsx

@@ -39,6 +39,8 @@ def __init__(
             config_dict (dict, optional): Dict containing values to be used to run the model. Defaults to national_config_dict.
             path_to_time_to_event_curves (str, optional): Path to folder containing time to event curves as CSV files. Defaults to "reference/survival_time_to_event_curves".
         """
+        self.region = config_dict["region"]
+        self.centre = config_dict["centre"]
         self.trace = config_dict.get("trace", False)
         self.initialise_prevalent_patients = config_dict.get(
             "initialise_prevalent_patients", True

renal_capacity_model/config.py

@@ -10,6 +10,8 @@
 logger = get_logger(__name__)
 
 national_config_dict = {
+    "region": "England",
+    "centre": "All",
     "multipliers": {
         "ttd": {
             "inc": 1,

renal_capacity_model/config_values.py

@@ -231,6 +231,8 @@ def load_scenario_from_excel(
             },
         }
     # The config values below this point are not different between validation and experimentation
+    config_from_excel["region"] = input_scenario.iat[0, 4]
+    config_from_excel["centre"] = input_scenario.iat[0, 6]
     config_from_excel["sim_duration"] = input_scenario.iat[0, 1]
     config_from_excel["age_dist"] = {
         1: input_scenario.iat[6, 1],

renal_capacity_model/load_scenario.py

@@ -62,6 +62,8 @@ def main(
             filepaths.append(copy_excel_files(excel_file, run_start_time))
         write_results_to_excel(
             filepaths[1],
+            config.region,
+            config.centre,
             combined_results,
             trial.costs_dfs,
             sim_years=int(config.sim_duration / 365),

renal_capacity_model/main.py

@@ -4,6 +4,7 @@
 from renal_capacity_model.helpers import get_logger
 import os
 import shutil
+from openpyxl import load_workbook
 
 logger = get_logger(__name__)
 
@@ -193,6 +194,8 @@ def copy_excel_files(path_to_file: str, run_start_time: str) -> str:
 
 def write_results_to_excel(
     path_to_results_excel_file: str,
+    model_region: str,
+    model_centre: str,
     combined_df: pd.DataFrame,
     costs_dfs: dict[str, pd.DataFrame],
     sim_years: int,
@@ -206,6 +209,14 @@ def write_results_to_excel(
         model simulation, for each model run
         sim_years (int): Number of years of sim duration, to truncate model result dataframes
     """
+
+    """Write region and centre name into the simulation summary results sheet"""
+    workbook = load_workbook(path_to_results_excel_file)
+    sheet_name = "Experiment Summary"
+    sheet = workbook[sheet_name]
+    sheet["G14"] = model_region
+    sheet["G15"] = model_centre
+    workbook.save(path_to_results_excel_file)
     with pd.ExcelWriter(
         path_to_results_excel_file,
         engine="openpyxl",
@@ -220,6 +231,7 @@ def write_results_to_excel(
             df.iloc[:, : sim_years + 1].to_excel(
                 writer, sheet_name=f"{activity}_yearly"
             )
+
     logger.info(
         f"✅ 💾 Excel format model results written to: \n{path_to_results_excel_file}"
     )