-
Notifications
You must be signed in to change notification settings - Fork 3
JOSS paper submission #33
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
lymereJ
wants to merge
36
commits into
develop
Choose a base branch
from
joss_paper
base: develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+201
−0
Open
Changes from 4 commits
Commits
Show all changes
36 commits
Select commit
Hold shift + click to select a range
93fe589
Add action and very first draft of the paper.
lymereJ 0851c9f
Fix typo.
lymereJ 95e88d1
Fix references.
lymereJ fdf851b
Minor typos.
lymereJ c83f341
Fix typo and add Julian's ORCID.
lymereJ ee21b7f
jxl mods
leijerry888 42cf3e0
address comments
leijerry888 33e62a0
fix ref typo
leijerry888 80e766e
paper update
leijerry888 6e6f846
typo fix
leijerry888 2a2da22
update paper contents based on reviewer comments
leijerry888 5335b5a
remove mac file
leijerry888 c804422
add back authors
leijerry888 4e3be02
Update paper.md
yanchenpnnl 48c33e6
Merge branch 'develop' into joss_paper
lymereJ 19036ad
Update GH action to create JOSS paper.
lymereJ 32050a0
Merge branch 'joss_paper' into joss_paper_rev
lymereJ 6007164
address jl comments
leijerry888 5ae6b2a
update bib
leijerry888 b9a5c16
paper revision wip
leijerry888 bfcc795
Fix citation in JOSS paper
AdamRJensen 2d5fc29
Add report number and url to and change report to techreport
AdamRJensen 025c3f3
Merge pull request #109 from AdamRJensen/patch-1
leijerry888 e5742ff
revise draft based on comments in https://github.com/openjournals/jos…
leijerry888 530f20b
add contract no in aknowledgement
leijerry888 84dfd63
Merge branch 'develop' into joss_paper
leijerry888 b0ab04e
Merge pull request #110 from AdamRJensen/patch-2
leijerry888 51f5e4d
add doi per request
leijerry888 7b7ec01
add doi for openstudio
leijerry888 2acc770
Merge pull request #115 from pnnl/add_doi
leijerry888 e54488c
Merge branch 'joss_paper_rev' into joss_paper
leijerry888 9fb0fb4
add footnote for Fan
leijerry888 6b86e38
save bib
leijerry888 149204e
update paper after int review
leijerry888 9c5b6ff
update refs
leijerry888 6ad222e
modify based on Jeremy feedback
leijerry888 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| on: [push] | ||
|
|
||
| jobs: | ||
| paper: | ||
| runs-on: ubuntu-latest | ||
| name: Paper Draft | ||
| steps: | ||
| - name: Checkout | ||
| uses: actions/checkout@v4 | ||
| - name: Build draft PDF | ||
| uses: openjournals/openjournals-draft-action@master | ||
| with: | ||
| journal: joss | ||
| # This should be the path to the paper within your repo. | ||
| paper-path: ./docs/paper.md | ||
| - name: Upload | ||
| uses: actions/upload-artifact@v1 | ||
| with: | ||
| name: paper | ||
| # This is the output path where Pandoc will write the compiled | ||
| # PDF. Note, this should be the same directory as the input | ||
| # paper.md | ||
| path: ./docs/paper.pdf |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| @misc {90.1, | ||
| title={ANSI/ASHRAE/IES 90.1-2019, Energy Standard for Buildings Except Low-Rise Residential Buildings}, | ||
| author={{ASHRAE}}, | ||
| organization={ASHRAE}, | ||
| institution={ASHRAE}, | ||
| address={Atlanta, GA}, | ||
| year={2019} | ||
| } | ||
|
|
||
| @misc{tspr, | ||
| title={TSPR Washington State Analysis Tool}, | ||
| author={{Pacific Northwest National Laboratory}}, | ||
| howpublished={\url{https://energycode.pnl.gov/HVACSystemPerformance/}}, | ||
| note={Accessed: 2024-04-044} | ||
| } | ||
|
|
||
| @report{impl_ctrl, | ||
| title={Implementation of Energy Code Controls Requirements in New Commercial Buildings}, | ||
| author={{Rosenberg, M.I., P.R. Hart, M. Hatten, D. Jones, and M. Cooper}}, | ||
| year={2017} | ||
| } | ||
|
|
||
| @report{impa_ctrl, | ||
| title={Impacts of commercial building controls on energy savings and peak load reduction}, | ||
| author={{Fernandez, Nicholas EP, et al.}}, | ||
| year={2017} | ||
| } | ||
|
|
||
| @misc{os, | ||
| title={OpenStudio}, | ||
| author={{National Renewable Energy Laboratory, Argonne National Laboratory, Lawrence Berkeley National Laboratory, Oak Ridge National Laboratory, Pacific Northwest National Laboratory}}, | ||
| howpublished={\url{https://openstudio.net/}}, | ||
| note={Accessed: 2024-04-04} | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| --- | ||
| title: 'Control Strainer (ConStrain): a data-driven control verification framework' | ||
| tags: | ||
| - python | ||
| - energy | ||
| - building | ||
| - control | ||
| - simulation | ||
| - hvac | ||
| authors: | ||
| - name: Xuechen Lei | ||
| orcid: 0000-0003-3310-9750 | ||
| affiliation: 1 | ||
| - name: Jérémy Lerond | ||
| orcid: 0000-0002-1630-6886 | ||
| affiliation: 1 | ||
| - name: Yun Joon Jung | ||
| orcid: 0000-0003-1311-8932 | ||
| affiliation: 1 | ||
| - name: Julian Slane-Holloway | ||
| affiliation: 1 | ||
| - name: Fan Feng | ||
| orcid: 0000-0002-6230-0063 | ||
| affiliation: 1 | ||
| - name: Yan Chen | ||
| orcid: 0000-0002-2988-9136 | ||
| affiliation: 1 | ||
|
|
||
| affiliations: | ||
| - name: Pacific Northwest National Laboratory, Richland, WA, USA | ||
| index: 1 | ||
| date: 4 Avril 2024 | ||
|
lymereJ marked this conversation as resolved.
Outdated
|
||
| bibliography: paper.bib | ||
| --- | ||
|
|
||
| # Summary | ||
|
|
||
| The Control Strainer, or `ConStrain`, is a python-based framework that can be used by energy modelers, building engineers, and researchers to conduct consistent and automated verification of building system controls using either timeseries generated from whole-building energy simulations or from actual building automation system trend data. `ConStrain` is made of three distinct parts: a control verification algorithm library, an automated preparation process and verification case generation, and a standardized performance evaluation and reporting process. At its roots, `ConStrain`'s verification library was developed with the verification of control related building energy code requirements in mind, but it is built such that its library is expandable and can cover any type of customized control verifications. | ||
|
|
||
| # Statement of need | ||
|
|
||
| Advances in building control have shown significant potential for improving building energy performance and decarbonization. Studies show that designs utilizing optimized controls that are properly tuned could cut commercial building energy consumption by approximately 29% - equivalent to 4-5 Quads, or 4-5% of the energy consumed in the United States [@impa_ctrl]. Driven by the significant control-related energy-saving potential, commercial building energy codes (such as ASHRAE 90.1 [@90.1]) have progressed with many control-related addenda. For example, from the publication of 90.1-2004 to 90.1-2016 (four code cycles), 30% of the new requirements are related to building control (with most of them focused on HVAC system control) [@impl_ctrl]. | ||
|
|
||
| However, one of the challenges to realizing those savings is the correct implementation of such advanced control strategies and regularly verifying their actual operational performance. A field study found that only 50% of systems observed have their control system correctly configured to meet the energy codes requirement, and control-related compliance verification is typically not included in the commissioning scope. Current control verification is often conducted manually, which is time-consuming, ad-hoc, incomplete, and error-prone. | ||
|
Collaborator
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @leijerry888 - Missing reference? |
||
|
|
||
| `ConStrain` can be used as a standalone tool and can also be integrated into existing workflows. `ConStrain` has been successfully integrated as part of the continuous integration software development process of whole-building energy simulation-based software tool (e.g., Washington State's Total System Performance Ratio Analysis Tool [@tspr]) to make sure that software code contributions as well as simulation software updates doesn't affect the simulated performance of building system controls. Moreover, a set of `OpenStudio` [@os] measures have also been developed to provide enable energy modelers using this platform to have access to perform verification on their models with close to no setup. | ||
|
|
||
| # Acknowledgements | ||
|
|
||
| ConStrain was developed at the Pacific Northwest National Laboratory and was funded under contract with the U.S. Department of Energy (DOE). It is actively being developed as an open-source project. | ||
|
|
||
| # References | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.