NOTE: SUBMIT A PLAN TO DEER SUPPORT PRIOR TO WORKING ON CODE FOR A MEASURE, FEATURE, OR BUG TO BE CONNECTED WITH OTHERS WORKING ON THE SAME ISSUE OR TO RECEIVE FEEDBACK ON YOUR PROPOSED METHOD
DEER Support Email: DeerSupport@dnv.com
PR Author
[x ] Make sure the PR branch is up to date with main branch at the time of the PR submission
[x ] Craft a succinct title that effectively encapsulates the essence of the pull request, providing a general overview of the proposed changes.
[ ] Label the PR with at least one of the following: New Measure, Bug, or Feature.
[x ] Provide a concise description of the measure, bug, or feature. Submit one PR per measure.
Added a script located in the \cases\ folder that builds the cases and cohorts used for simulation. Added example cohorts_old.csv, cohorts_list.csv and cases files for each system type.
Use when the measure is identical for all prototypes
There should be one template file in the \cases\ directory for each system type that is applicable to the measure
The script takes cohorts data from cohorts_old.csv and a list of Measure Group Names from cohorts_list.csv, and creates a new cohorts.csv and cases files. It overwrites cohorts.csv.
Update system_types on line 17 to include the ones needed for the measure
Update cohorts_list to list all of the Measure Group Names (column N) from DEER_EnergyPlus_Modelkit_Measure_list_working.xlsx
Run this file from \cases\
[ ] For a new measure, attach a workbook named DEER_EnergyPlus_Modelkit_Measure_list_working.xlsx, containing only rows used for post-processing the measure.
[ ] Add comments in the code when necessary to facilitate the review process.
[ ] Add a comment before the added code, including the author's full name, company, and specifying if it's a bug fix, new measure, or feature.
[ ] For a new feature or bug, demonstrate the impact on energy consumption for selected cases with justification using plots and descriptions.
[ ] For a new measure, add a summary table showing total energy consumption per simulated case.
PR Reviewer
[ ] Conduct a thorough code review.
[ ] If the branch is behind the main, merge the branch locally to check for potential conflicts.
[ ] If a bug, locally reproduce it and compare energy consumptions before and after.
[ ] Explore creative ways to stress-test the code.
[ ] Locally check the error file and other outputs.
Pull Request (PR) Description
NOTE: SUBMIT A PLAN TO DEER SUPPORT PRIOR TO WORKING ON CODE FOR A MEASURE, FEATURE, OR BUG TO BE CONNECTED WITH OTHERS WORKING ON THE SAME ISSUE OR TO RECEIVE FEEDBACK ON YOUR PROPOSED METHOD
DEER Support Email: DeerSupport@dnv.com
PR Author
PR Reviewer