Merge branch 'changelog' into transmission_multiplier

Author: staadecker

REAM Model Changelog.md

@@ -1,27 +1,18 @@
-# REAM Model Changelog
+# REAM Model Breaking Changes
 
-This file specifies the changes that we have done to the model.
+This file specifies the breaking changes that we have done to the model.
+A breaking change is any change that would change the results of previously
+completed runs.
 
-Pull requests that change the model in a way that will impact our
-results should list their changes here. Pull requests that don't affect our results 
-(e.g. improvements to performance, refactors, workflow, etc.) should not
-update this file.
-
-## Changes to model
+## List of breaking changes to model
 
 Changes are listed from oldest (first line) to newest (last line of table).
 
 | PR | Month | Change description |
 | ---- | --- | ---------------------|
-| #8 | Feb 2021 | feat: Add support for other types of GHGs (NOx, SO2, CH4) |
-| #12 | March 2021 |fix: use the middle of the period instead of the start as the cutoff for retirement and predetermined buildout. |
-| #15 | March 2021 |fix: Fix bug where storage costs where being over-counted. |
-| #36 | May 2021 |fix: Remove duplicate transmission lines |
-| #10 | June 2021 | feat: Add support for California policies module |
-| #40  | June 2021 | feat: Add support for planning reserves module |
-| #50 | June 2021 | Upgraded to Pyomo 6.0 |
-| #56 | June 2021 | fix: Convert 2020 predetermined build years to 2019 in get_inputs to avoid conflicts with 2020 period. |
-| #57 | June 2021 | fix: specify predetermined storage energy capacity (previously left unspecified). |
-| #42 | June 2021| feat: Add parameters to the storage module for self-discharge rate, land use and discharge efficiency. |
-| #68 | June 2021 | fix: change financial params to 2018 dollars & 5% interest rate. Start using terrain multipliers (which now include the economic multiplier). |
-| #72 | June-July 2021 | fix: drop build and O&M costs of existing transmission lines |
+| #12 | March 2021 | Use the middle of the period instead of the start as the cutoff for retirement and predetermined buildout. |
+| #15 | March 2021 | Fix bug where storage costs where being over-counted. |
+| #36 | May 2021 | Correct inputs to only list transmission lines in one direction. |
+| #56 | June 2021 | Convert 2020 predetermined build years to 2019 in `get_inputs.py` to avoid conflicts with 2020 period. |
+| #57 | June 2021 | Specify predetermined storage energy capacity in inputs (previously left unspecified). |
+| #68 | June 2021 | Change financial params to 2018 dollars & 5% interest rate. Start using terrain multipliers (which now include the economic multiplier). |

docs/Contribute.md

@@ -14,7 +14,9 @@ procedure.
 3. Once your changes are final and ready to be added to the switch main
 branch, create a pull request on Github.
 
-4. Get someone to review and then merge your changes on Github.
+4. If your change is a breaking change add it to `REAM Model Changelog.md`.
+   
+5. Get someone to review and then merge your changes on Github.
 
 For more information read [this excellent guide](https://guides.github.com/introduction/flow/) (5 min read).