GridPath v2010.10.1

Merge pull request #1318 from blue-marble/develop

Author: anamileva

gridpath/common_functions.py

@@ -289,6 +289,13 @@ def get_run_scenario_parser():
         "summary results.",
     )
 
+    parser.add_argument(
+        "--skip_quick_summary",
+        default=False,
+        action="store_true",
+        help="Skip quick summary text file",
+    )
+
     return parser
 
 

gridpath/project/capacity/capacity.py

@@ -451,6 +451,7 @@ def summarize_results(
     availability_iteration,
     subproblem,
     stage,
+    skip_quick_summary,
 ):
     """
     :param scenario_directory:
@@ -476,22 +477,9 @@ def summarize_results(
 
     # Open in 'append' mode, so that results already written by other
     # modules are not overridden
-    with open(summary_results_file, "a") as outfile:
-        outfile.write("\n### CAPACITY RESULTS ###\n")
-
-    # Get the results CSV as dataframe
-    capacity_results_df = pd.read_csv(
-        os.path.join(
-            scenario_directory,
-            weather_iteration,
-            hydro_iteration,
-            availability_iteration,
-            subproblem,
-            stage,
-            "results",
-            "project_period.csv",
-        )
-    )
+    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,
@@ -516,5 +504,6 @@ def summarize_results(
                 availability_iteration,
                 subproblem,
                 stage,
+                skip_quick_summary,
                 summary_results_file,
             )

gridpath/project/capacity/capacity_types/dr_new.py

@@ -479,6 +479,7 @@ def summarize_results(
     availability_iteration,
     subproblem,
     stage,
+    skip_quick_summary,
     summary_results_file,
 ):
     """
@@ -490,41 +491,42 @@ def summarize_results(
     :return:
     """
 
-    # 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,
-    )
+    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 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)
+        # 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),
-    ]
+        # 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.",
-    )
+        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

@@ -516,6 +516,7 @@ def summarize_results(
     availability_iteration,
     subproblem,
     stage,
+    skip_quick_summary,
     summary_results_file,
 ):
     """
@@ -527,37 +528,38 @@ def summarize_results(
     :return:
     """
 
-    # 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,
-    )
+    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 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)
+        # 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)]
+        # 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.",
-    )
+        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

@@ -681,6 +681,7 @@ def summarize_results(
     availability_iteration,
     subproblem,
     stage,
+    skip_quick_summary,
     summary_results_file,
 ):
     """
@@ -691,58 +692,60 @@ def summarize_results(
     :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 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 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)
+        # 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),
-    ]
+        # 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.",
+        )
 
-    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")
+        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