Merge develop ashrae9012022

.github/workflows/python-app.yml

@@ -19,6 +19,29 @@ jobs:
       - uses: psf/black@stable
         with:
           version: "22.6.0"
+
+  detect-changes:
+    name: Detect changed rulesets
+    runs-on: ubuntu-latest
+    outputs:
+      ashrae9012019: ${{ steps.filter.outputs.ashrae9012019 }}
+      ashrae9012022: ${{ steps.filter.outputs.ashrae9012022 }}
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Detect file changes
+        id: filter
+        uses: dorny/paths-filter@v3
+        with:
+          filters: |
+            ashrae9012019:
+              - 'rct229/rulesets/ashrae9012019/**'
+              - 'rct229/ruletest_engine/ruletest_jsons/ashrae9012019/**'
+            ashrae9012022:
+              - 'rct229/rulesets/ashrae9012022/**'
+              - 'rct229/ruletest_engine/ruletest_jsons/ashrae9012022/**'
+
   run-unit-tests:
     name: Run unit tests
     runs-on: 'ubuntu-latest'
@@ -35,7 +58,52 @@ jobs:
       - name: Install venv
         run: poetry install
       - name: Run pytests
-        # This will halt the action if any of the tests fail
         run: poetry run pytest -v
-      - name: Run rule tests
-        run: poetry run rct229 test -rs ashrae9012019
+
+  run-ruletests-2019:
+    name: Run 2019 rule tests
+    runs-on: ubuntu-latest
+    needs: detect-changes
+    if: needs.detect-changes.outputs.ashrae9012019 == 'true'
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Setup Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.10'
+
+      - name: Install Poetry
+        run: |
+          curl -sSL https://install.python-poetry.org | python3 - --version 1.8.4
+
+      - name: Install dependencies
+        run: poetry install
+
+      - name: Run rule tests for 90.1-2019
+        run: poetry run rct229 test -rs ashrae9012019
+
+  run-ruletests-2022:
+    name: Run 2022 rule tests
+    runs-on: ubuntu-latest
+    needs: detect-changes
+    if: needs.detect-changes.outputs.ashrae9012022 == 'true'
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Setup Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.10'
+
+      - name: Install Poetry
+        run: |
+          curl -sSL https://install.python-poetry.org | python3 - --version 1.8.4
+
+      - name: Install dependencies
+        run: poetry install
+
+      - name: Run rule tests for 90.1-2022
+        run: poetry run rct229 test -rs ashrae9012022

DISCLAIMER.md

@@ -1,16 +1,23 @@
-Disclaimer
-
-This material was prepared as an account of work sponsored by an agency of the United States Government. Neither the United States Government nor the United States Department of Energy, nor Battelle, nor any of their employees, nor any jurisdiction or organization that has cooperated in the development of these materials, makes any warranty, express or implied, or assumes any legal liability or responsibility for the accuracy, completeness, or usefulness or any information, apparatus, product, software, or process disclosed, or represents that its use would not infringe privately owned rights.
-
-Reference herein to any specific commercial product, process, or service by trade name, trademark, manufacturer, or otherwise does not necessarily constitute or imply its endorsement, recommendation, or favoring by the United States Government or any agency thereof, or Battelle Memorial Institute. The views and opinions of authors expressed herein do not necessarily state or reflect those of the United States Government or any agency thereof.
-
-PACIFIC NORTHWEST NATIONAL LABORATORY
-operated by
-
-BATTELLE
-
-for the
-
-UNITED STATES DEPARTMENT OF ENERGY
-
-under Contract DE-AC05-76RL0183
+DISCLAIMER
+This material was prepared as an account of work sponsored by an agency of the
+United States Government.  Neither the United States Government nor the United
+States Department of Energy, nor Battelle, nor any of their employees, nor any
+jurisdiction or organization that has cooperated in the development of these
+materials, makes any warranty, express or implied, or assumes any legal
+liability or responsibility for the accuracy, completeness, or usefulness or
+any information, apparatus, product, software, or process disclosed, or
+represents that its use would not infringe privately owned rights.
+
+Reference herein to any specific commercial product, process, or service by
+trade name, trademark, manufacturer, or otherwise does not necessarily
+constitute or imply its endorsement, recommendation, or favoring by the United
+States Government or any agency thereof, or Battelle Memorial Institute. The
+views and opinions of authors expressed herein do not necessarily state or
+reflect those of the United States Government or any agency thereof.
+
+                PACIFIC NORTHWEST NATIONAL LABORATORY
+                             operated by
+                               BATTELLE
+                               for the
+                  UNITED STATES DEPARTMENT OF ENERGY
+                   under Contract DE-AC05-76RL01830

LICENSE

@@ -1,10 +1,23 @@
-Ruleset Checking Tool
-Copyright © 2021, Battelle Memorial Institute
-All rights reserved.
-
-1.	Battelle Memorial Institute (hereinafter Battelle) hereby grants permission to any person or entity lawfully obtaining a copy of this software and associated documentation files (hereinafter “the Software”) to redistribute and use the Software in source and binary forms, with or without modification.  Such person or entity may use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and may permit others to do so, subject to the following conditions:
-•	Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimers. 
-•	Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 
-•	Other than as used herein, neither the name Battelle Memorial Institute or Battelle may be used in any form whatsoever without the express written consent of Battelle.  
-
-2.	THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL BATTELLE OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+LICENSE
+Copyright Battelle Memorial Institute 2021
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+this list of conditions and the following disclaimer in the documentation
+and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

README.md

@@ -28,11 +28,16 @@ Ruleset Checking Tool for ANSI/ASHRAE/IES Standard 90.1-2019 Appendix G
 This package provides a reference implementation of a Ruleset Checking Tool (RCT) in support of ASHRAE Standard 229P.  The RCT is not intended to be a normative part of the proposed standard, so use with Std 229P is optional.  This RCT implementation is specific to ANSI/ASHRAE/IES Standard 90.1-2019 Appendix G and does not support any other rulesets.  Final release of this package is dependent upon acceptance and publication of ASHRAE Standard 229P.
 
 ## Install it from PyPI
-
+By default, the package includes the ASHRAE 90.1-2019 PRM ruleset.
 ```bash
 pip install ruleset-checking-tool
 ```
 
+To install additional rulesets, you can install them as optional dependencies. For example, to install the ASHRAE 90.1-2022 ruleset, you can run:
+```bash
+pip install ruleset-checking-tool[ashrae9012022]
+```
+
 ## Usage
 
 ```py
@@ -113,17 +118,25 @@ The following provides some useful commands as you get started developing the RC
 This package is developed using Poetry to manage packages during the build process.  First, follow the instruction from [poetry](https://python-poetry.org/docs/) to install the package.
 Any new dependencies that are added to the package must be included in the pyproject.toml. The package is currently being developed for Python 3.10. This version of Python must be installed on your machine for Poetry to work properly.
 
-Now tests can be run by first installing dependencies and then running pytest.
-1. `poetry install`
-2. `poetry run pytest`
-    - To see a coverage report, use `poetry run pytest --cov`
-    - To have pytest watch for file changes, use `poetry run ptw`
+By default, the RCT package includes the ASHRAE 90.1-2019 PRM ruleset.  
+`poetry install`
+
+To install additional rulesets, you can install them as optional dependencies. For example, to install the ASHRAE 90.1-2022 ruleset, you can run:  
+`poetry install --extras ashrae9012022`
+
+You can also install all available rulesets by running:  
+`poetry install --all-extras`
+
+Now tests can be run by first installing dependencies and then running pytest.  
+`poetry run pytest`
+- To see a coverage report, use `poetry run pytest --cov`
+- To have pytest watch for file changes, use `poetry run ptw`
 
-You can also package with poetry to test the CLI tool.
-2. `poetry run rct229 test`
+You can also package with poetry to test the CLI tool.  
+`poetry run rct229 test`
 
-Run with example ASHRAE 90.1 2019 RPDs.
-1. `poetry run rct229 evaluate -rs ashrae9012019 -f examples\chicago_demo\baseline_model.json -f examples\chicago_demo\proposed_model.json -f examples\chicago_demo\user_model.json -r ASHRAE9012019_DETAIL`
+Run with example ASHRAE 90.1 2019 RPDs.  
+`poetry run rct229 evaluate -rs ashrae9012019 -f examples\chicago_demo\baseline_model.json -f examples\chicago_demo\proposed_model.json -f examples\chicago_demo\user_model.json -r ASHRAE9012019_DETAIL`
 
 
 ### Developer Notes
@@ -165,7 +178,7 @@ Before committing changes you should run the following commands from the `rulese
   2. Add a new item to the `rules_dict` in the rulset's `rct229/rulesets/<RULESET>/__init__.py` file with the unique rule ID and desired rule section and number.
   3. Create the new rule module in the ruleset directory following the typical procedure, but using the unique rule ID as the rule's class name.
   ```python
-        class PRM9012019Rule86h31(RuleDefinitionBase):
+class PRM9012019Rule86h31(RuleDefinitionBase):
   ```
 
 - For renumbering a rule to remain in the same section: