Remove summarize_results (#1340)

Will handle summaries differently.

Author: anamileva

gridpath/auxiliary/import_export_rules.py

@@ -31,70 +31,72 @@ def export_rule_use(instance, quiet):
     if unserved_energy_found:
         if not quiet:
             print("unserved energy found; exporting results")
-
-    return unserved_energy_found
-
-
-def summarize_results_use(
-    scenario_directory,
-    weather_iteration,
-    hydro_iteration,
-    availability_iteration,
-    subproblem,
-    stage,
-    quiet,
-):
-    if os.path.exists(
-        os.path.join(
-            scenario_directory,
-            weather_iteration,
-            hydro_iteration,
-            availability_iteration,
-            subproblem,
-            stage,
-            "results",
-            "system_load_zone_timepoint.csv",
-        )
-    ):
-        return True
     else:
         if not quiet:
-            print("skipping results summary")
-        return False
+            print("no unserved energy found; skipping results export")
+
+    return unserved_energy_found
 
 
-def import_rule_use(results_directory, quiet):
+def sys_lz_tmp_csv_based_rule(results_directory, quiet):
+    """
+    Returns True if the results directory contains a system_load_zone_timepoint.csv file.
+    """
     if os.path.exists(
         os.path.join(results_directory, "system_load_zone_timepoint.csv")
     ):
         import_results = True
         if not quiet:
-            print("unserved energy found -- importing")
+            print("'system_load_zone_timepoint' found -- processing")
     else:
         import_results = False
         if not quiet:
-            print("no unserved energy -- skipping")
+            print("'system_load_zone_timepoint' not found -- skipping")
 
     return import_results
 
 
+def sys_lz_tmp_csv_based_rule_w_dir_args(
+    scenario_directory,
+    weather_iteration,
+    hydro_iteration,
+    availability_iteration,
+    subproblem,
+    stage,
+    quiet,
+):
+    results_directory = os.path.join(
+        scenario_directory,
+        weather_iteration,
+        hydro_iteration,
+        availability_iteration,
+        subproblem,
+        stage,
+        "results",
+    )
+
+    flag = sys_lz_tmp_csv_based_rule(results_directory, quiet)
+    return flag
+
+
+# These are high-level rules for whether or not to run each results-side step of
+# GridPath_E2E
 import_export_rules = {
+    # Only export results if USE is found; export summaries; summarize
+    # results and import results only if system_load_zone_timepoint.csv is found
     "USE": {
         "export": export_rule_use,
         "export_summary": True,
-        "summarize": summarize_results_use,
-        "import": import_rule_use,
+        "import": sys_lz_tmp_csv_based_rule,
     },
     "USE_import_only": {
         "export": True,
         "export_summary": True,
-        "summarize": True,
-        "import": import_rule_use,
+        "import": sys_lz_tmp_csv_based_rule,
     },
     "summary_only": {
         "export": lambda instance, quiet: False,
         "export_summary": lambda instance: True,
-        "summarize": lambda scenario_directory, weather_iteration, hydro_iteration, availability_iteration, subproblem, stage, quiet,: False,
         "import": lambda results_directory, quiet: True,
     },
 }

gridpath/project/capacity/capacity.py

@@ -442,68 +442,3 @@ def export_results(
                 if column not in getattr(d, PROJECT_PERIOD_DF):
                     getattr(d, PROJECT_PERIOD_DF)[column] = None
             getattr(d, PROJECT_PERIOD_DF).update(optype_df)
-
-
-def summarize_results(
-    scenario_directory,
-    weather_iteration,
-    hydro_iteration,
-    availability_iteration,
-    subproblem,
-    stage,
-    skip_quick_summary,
-):
-    """
-    :param scenario_directory:
-    :param subproblem:
-    :param stage:
-    :return:
-
-    Summarize capacity results
-    """
-
-    summary_results_file = os.path.join(
-        scenario_directory,
-        weather_iteration,
-        hydro_iteration,
-        availability_iteration,
-        subproblem,
-        stage,
-        "results",
-        "summary_results.txt",
-    )
-    # Check if the 'technology' exists in  projects.tab; if it doesn't, we
-    # don't have a category to aggregate by, so we'll skip summarizing results
-
-    # Open in 'append' mode, so that results already written by other
-    # modules are not overridden
-    if not skip_quick_summary:
-        with open(summary_results_file, "a") as outfile:
-            outfile.write("\n### CAPACITY RESULTS ###\n")
-
-    required_capacity_modules = get_required_subtype_modules(
-        scenario_directory=scenario_directory,
-        weather_iteration=weather_iteration,
-        hydro_iteration=hydro_iteration,
-        availability_iteration=availability_iteration,
-        subproblem=subproblem,
-        stage=stage,
-        which_type="capacity_type",
-    )
-
-    # Import needed capacity type modules
-    imported_capacity_modules = load_project_capacity_type_modules(
-        required_capacity_modules
-    )
-    for op_m in required_capacity_modules:
-        if hasattr(imported_capacity_modules[op_m], "summarize_results"):
-            imported_capacity_modules[op_m].summarize_results(
-                scenario_directory,
-                weather_iteration,
-                hydro_iteration,
-                availability_iteration,
-                subproblem,
-                stage,
-                skip_quick_summary,
-                summary_results_file,
-            )

gridpath/project/capacity/capacity_types/dr_new.py

@@ -472,63 +472,6 @@ def add_to_project_period_results(
     return results_columns, captype_df
 
 
-def summarize_results(
-    scenario_directory,
-    weather_iteration,
-    hydro_iteration,
-    availability_iteration,
-    subproblem,
-    stage,
-    skip_quick_summary,
-    summary_results_file,
-):
-    """
-    Summarize new DR capacity results.
-    :param scenario_directory:
-    :param subproblem:
-    :param stage:
-    :param summary_results_file:
-    :return:
-    """
-
-    if not skip_quick_summary:
-        # Get the results CSV as dataframe
-        capacity_results_agg_df = read_results_file_generic(
-            scenario_directory=scenario_directory,
-            weather_iteration=weather_iteration,
-            hydro_iteration=hydro_iteration,
-            availability_iteration=availability_iteration,
-            subproblem=subproblem,
-            stage=stage,
-            capacity_type=Path(__file__).stem,
-        )
-
-        # Get all technologies with new build DR power OR energy capacity
-        new_build_df = pd.DataFrame(
-            capacity_results_agg_df[
-                (capacity_results_agg_df["new_build_mw"] > 0)
-                | (capacity_results_agg_df["new_build_mwh"] > 0)
-            ][["new_build_mw", "new_build_mwh"]]
-        )
-
-        # Get the power and energy units from the units.csv file
-        power_unit, energy_unit, fuel_unit = get_units(scenario_directory)
-
-        # Rename column header
-        columns = [
-            "New DR Power Capacity ({})".format(power_unit),
-            "New DR Energy Capacity ({})".format(energy_unit),
-        ]
-
-        write_summary_results_generic(
-            results_df=new_build_df,
-            columns=columns,
-            summary_results_file=summary_results_file,
-            title="New DR Capacity",
-            empty_title="No new DR was built.",
-        )
-
-
 # Database
 ###############################################################################
 

gridpath/project/capacity/capacity_types/energy_new_lin.py

@@ -509,59 +509,6 @@ def add_to_project_period_results(
     return results_columns, captype_df
 
 
-def summarize_results(
-    scenario_directory,
-    weather_iteration,
-    hydro_iteration,
-    availability_iteration,
-    subproblem,
-    stage,
-    skip_quick_summary,
-    summary_results_file,
-):
-    """
-    Summarize new build generation energy results.
-    :param scenario_directory:
-    :param subproblem:
-    :param stage:
-    :param summary_results_file:
-    :return:
-    """
-
-    if not skip_quick_summary:
-        # Get the results CSV as dataframe
-        energy_results_agg_df = read_results_file_generic(
-            scenario_directory=scenario_directory,
-            weather_iteration=weather_iteration,
-            hydro_iteration=hydro_iteration,
-            availability_iteration=availability_iteration,
-            subproblem=subproblem,
-            stage=stage,
-            capacity_type=Path(__file__).stem,
-        )
-
-        # Get all technologies with the new build energy
-        new_build_df = pd.DataFrame(
-            energy_results_agg_df[energy_results_agg_df["new_build_energy_mwh"] > 0][
-                "new_build_energy_mwh"
-            ]
-        )
-
-        # Get the units from the units.csv file
-        power_unit, energy_unit, fuel_unit = get_units(scenario_directory)
-
-        # Rename column header
-        columns = ["New Energy ({})".format(power_unit)]
-
-        write_summary_results_generic(
-            results_df=new_build_df,
-            columns=columns,
-            summary_results_file=summary_results_file,
-            title="New Energy Procurement",
-            empty_title="No new energy_new_lin generation was procured.",
-        )
-
-
 # Database
 ###############################################################################
 

gridpath/project/capacity/capacity_types/fuel_prod_new.py

@@ -672,82 +672,6 @@ def add_to_project_period_results(
     return results_columns, captype_df
 
 
-# TODO: add capacity type to the results file, so that we can filter the
-#  consolidated results file for the summaries
-def summarize_results(
-    scenario_directory,
-    weather_iteration,
-    hydro_iteration,
-    availability_iteration,
-    subproblem,
-    stage,
-    skip_quick_summary,
-    summary_results_file,
-):
-    """
-    Summarize new build storage capacity results.
-    :param scenario_directory:
-    :param subproblem:
-    :param stage:
-    :param summary_results_file:
-    :return:
-    """
-    if not skip_quick_summary:
-        # Get the results CSV as dataframe
-        capacity_results_agg_df = read_results_file_generic(
-            scenario_directory=scenario_directory,
-            weather_iteration=weather_iteration,
-            hydro_iteration=hydro_iteration,
-            availability_iteration=availability_iteration,
-            subproblem=subproblem,
-            stage=stage,
-            capacity_type=Path(__file__).stem,
-        )
-
-        # Get all technologies with new build production OR release OR energy capacity
-        new_build_df = pd.DataFrame(
-            capacity_results_agg_df[
-                (capacity_results_agg_df["new_fuel_prod_capacity_fuelunitperhour"] > 0)
-                | (capacity_results_agg_df["new_fuel_rel_capacity_fuelunitperhour"] > 0)
-                | (capacity_results_agg_df["new_fuel_stor_capacity_fuelunit"] > 0)
-            ][
-                [
-                    "new_fuel_prod_capacity_fuelunitperhour",
-                    "new_fuel_rel_capacity_fuelunitperhour",
-                    "new_fuel_stor_capacity_fuelunit",
-                ]
-            ]
-        )
-
-        # Get the units from the units.csv file
-        power_unit, energy_unit, fuel_unit = get_units(scenario_directory)
-
-        # Rename column header
-        columns = [
-            "New Fuel Production Capacity ({} per hour)".format(fuel_unit),
-            "New Fuel Release Capacity ({} per hour)".format(fuel_unit),
-            "New Fuel Storage Capacity ({})".format(fuel_unit),
-        ]
-
-        write_summary_results_generic(
-            results_df=new_build_df,
-            columns=columns,
-            summary_results_file=summary_results_file,
-            title="New Fuel Production, Release, and Storage Capacity",
-            empty_title="No new fuel production was built.",
-        )
-
-        with open(summary_results_file, "a") as outfile:
-            outfile.write(
-                "\n--> New Fuel Production, Release, and Storage Capacity <--\n"
-            )
-            if new_build_df.empty:
-                outfile.write("No new fuel production was built.\n")
-            else:
-                new_build_df.to_string(outfile, float_format="{:,.2f}".format)
-                outfile.write("\n")
-
-
 # Database
 ###############################################################################