Skip to content

Commit 9305646

Browse files
committed
update readme
1 parent 23a6d1a commit 9305646

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,11 +28,16 @@ Ruleset Checking Tool for ANSI/ASHRAE/IES Standard 90.1-2019 Appendix G
2828
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.
2929

3030
## Install it from PyPI
31-
31+
By default, the package includes the ASHRAE 90.1-2019 PRM ruleset.
3232
```bash
3333
pip install ruleset-checking-tool
3434
```
3535

36+
To install additional rulesets, you can install them as optional dependencies. For example, to install the ASHRAE 90.1-2022 ruleset, you can run:
37+
```bash
38+
pip install ruleset-checking-tool[ashrae9012022]
39+
```
40+
3641
## Usage
3742

3843
```py
@@ -173,7 +178,7 @@ Before committing changes you should run the following commands from the `rulese
173178
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.
174179
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.
175180
```python
176-
class PRM9012019Rule86h31(RuleDefinitionBase):
181+
class PRM9012019Rule86h31(RuleDefinitionBase):
177182
```
178183

179184
- For renumbering a rule to remain in the same section:

0 commit comments

Comments
 (0)