Clarify extra timepoints warning message since it applies to both plants that are retired early and plants whose construction is not complete in the first period. Also minor documentation update.

Author: josiahjohnston

switch_model/generators/core/dispatch.py

@@ -286,14 +286,17 @@ def _warn_on_extra_VARIABLE_GEN_TPS(m):
         pprint = "\n".join(
             "* {}: {}".format(g, tps) for g, tps in extraneous.items())
         warning_msg = (
-            "{} renewable generators have capacity factors specified "
-            "in timepoints after they are slated for retirement. This "
-            "could indicate a benign issue where the process that built "
-            "the dataset used simplified logic and/or didn't know the "
-            "scheduled retirement date. If you expect those datapoints to "
-            "be useful, then those plants need longer lifetimes (or "
-            "options to build new capacity when the old capacity reaches "
-            "the provided end-of-life date).\n".format(num_impacted_generators))
+            "{} renewable generators with predetermined builds have capacity "
+            "factors specified in timepoints in periods when they are not "
+            "operating (either after retirement, or before construction is "
+            "complete). This could indicate a benign issue where the process "
+            "that built the dataset used simplified logic and/or didn't know "
+            "the scheduled operational dates. If you expect those datapoints "
+            "to be useful, then those plants need to either come online "
+            "earlier, have longer lifetimes, or have options to build new "
+            "new capacity when the old capacity reaches the provided "
+            "end-of-life date."
+            "\n".format(num_impacted_generators))
         if extra_indexes:
             logging.warning(warning_msg)
             logging.info("Plants with extra timepoints:\n{}".format(pprint))

switch_model/generators/extensions/hydro_simple.py

@@ -120,14 +120,16 @@ def _warn_on_extra_HYDRO_GEN_TS(m):
         pprint = "\n".join(
             "* {}: {}".format(g, tps) for g, tps in extraneous.items())
         warning_msg = (
-            "{} hydro plants have data specified "
-            "in timeseries after they are slated for retirement. This "
+            "{} hydro plants with predetermined builds have timeseries data "
+            "in periods when they are not operating (either after retirement, "
+            "or before construction is complete). This "
             "could indicate a benign issue where the process that built "
             "the dataset used simplified logic and/or didn't know the "
-            "scheduled retirement date. If you expect those datapoints to "
-            "be useful, then those plants need longer lifetimes (or "
-            "options to build new capacity when the old capacity reaches "
-            "the provided end-of-life date).\n".format(num_impacted_generators))
+            "scheduled operating dates. If you expect those datapoints to "
+            "be useful, then those plants need to either come online earlier "
+            ", have longer lifetimes, or have options to build new capacity "
+            "when the old capacity reaches the provided end-of-life date."
+            "\n".format(num_impacted_generators))
         if extra_indexes:
             logging.warning(warning_msg)
             logging.info("Plants with extra timepoints:\n{}".format(pprint))

switch_model/timescales.py

@@ -326,7 +326,8 @@ def add_one_to_period_end_rule(m):
         mod.TIMEPOINTS,
         within=PositiveReals,
         initialize=lambda m, t: (
-            m.tp_weight[t] / m.period_length_years[m.tp_period[t]]))
+            m.tp_weight[t] / m.period_length_years[m.tp_period[t]]),
+        doc="This weight scales a timepoint to an annual average.")
     # Identify previous step for each timepoint, for use in tracking
     # unit commitment or storage. We use circular indexing (.prevw() method)
     # for the timepoints within a timeseries to give consistency between the