Fix typos in outputs/docs/src/etc. #10760

shorowit · 2024-09-23T15:00:24Z

Pull request overview

Fixes various typos in docs, src/test, IDD.
IDD changes are all in notes, so not a breaking change.
A couple src changes (that I point out below) change outputs

NOTE: ENHANCEMENTS MUST FOLLOW A SUBMISSION PROCESS INCLUDING A FEATURE PROPOSAL AND DESIGN DOCUMENT PRIOR TO SUBMITTING CODE

Pull Request Author

Add to this list or remove from it as applicable. This is a simple templated set of guidelines.

Reviewer

This will not be exhaustively relevant to every PR.

shorowit · 2024-09-23T15:01:09Z

src/EnergyPlus/ChillerAbsorption.cc

-                                                         "Iniital Design Size Design Generator Fluid Flow Rate [m3/s]",
+                                                         "Initial Design Size Design Generator Fluid Flow Rate [m3/s]",


Seems like this affects output?

Yeah probably worth mentioning at least. I can try to collect the changes here that "affect" output and add it to the new 25.1 output changes file.

shorowit · 2024-09-23T15:03:01Z

src/EnergyPlus/DXCoils.cc

-        state.dataOutRptPredefined->pdchVAVDXFanName = newPreDefColumn(state, state.dataOutRptPredefined->pdstVAVDXCoolCoil, "Assocated Fan");
+        state.dataOutRptPredefined->pdchVAVDXFanName = newPreDefColumn(state, state.dataOutRptPredefined->pdstVAVDXCoolCoil, "Associated Fan");


Affects output?

Affects output?

Yes

shorowit · 2024-09-23T15:05:15Z

src/EnergyPlus/HeatRecovery.cc

-                                                     : (this->type == HVAC::HXType::Desiccant_Balanced ? "Dessicant Balanced" : "Generic"));
+                                                     : (this->type == HVAC::HXType::Desiccant_Balanced ? "Desiccant Balanced" : "Generic"));


Affects output?

Affects output?

Yes

shorowit · 2024-09-23T15:06:32Z

src/EnergyPlus/HybridUnitaryAirConditioners.cc

-                            "Zone Hybrid Unitary HVAC DehumidificationLoad to Humidistat Setpoint Heat Tansfer Energy",
+                            "Zone Hybrid Unitary HVAC Dehumidification Load to Humidistat Setpoint Heat Transfer Energy",


Affects output?

Affects output?

Yes

shorowit · 2024-09-23T15:06:41Z

src/EnergyPlus/HybridUnitaryAirConditioners.cc

-                            "Zone Hybrid Unitary HVAC Humidification Load to Humidistat Setpoint Heat Tansfer Energy",
+                            "Zone Hybrid Unitary HVAC Humidification Load to Humidistat Setpoint Heat Transfer Energy",


Affects output?

A bunch of these HybridUnitaryAC outputs don't appear in the documentation.

Affects output?

Yes

shorowit · 2024-09-23T15:09:38Z

src/EnergyPlus/SteamBaseboardRadiator.cc

-                                                         "User-Speicified Maximum Steam Flow Rate [m3/s]",
+                                                         "User-Specified Maximum Steam Flow Rate [m3/s]",


Affects output?

Affects output?

Yes

shorowit · 2024-09-23T15:10:08Z

src/EnergyPlus/SurfaceGeometry.cc

-              "Visible Reflectance,Surface Glazing Fraction,Surface Glazing Contruction\n");
+              "Visible Reflectance,Surface Glazing Fraction,Surface Glazing Construction\n");


Affects output?

Affects output?

Yes

github-actions · 2024-09-23T17:36:57Z

⚠️ Regressions detected on macos-14 for commit `dbaffa3`

Regression Summary

Table Big Diffs: 23
Table String Diffs: 26
EIO: 8
ERR: 7
RDD: 1

github-actions · 2024-09-23T17:54:49Z

⚠️ Regressions detected on macos-14 for commit `e3dcda8`

Regression Summary

Table Big Diffs: 23
Table String Diffs: 26
EIO: 8
ERR: 7
RDD: 1

shorowit · 2024-09-23T19:47:44Z

I looked through a bunch of the regression files and they are all typo fixes to column names, etc. This should be good to go, other than needing to mention all these output changes in OutputChanges.md (which I could use some help with).

…os_galore

github-actions · 2024-10-10T13:43:42Z

⚠️ Regressions detected on macos-14 for commit `752e591`

Regression Summary

Table Big Diffs: 23
Table String Diffs: 26
EIO: 8
ERR: 7
RDD: 1

mjwitte

@Myoldmopar @shorowit Sooo many changes, surprising, but no surprising.

I've added the output changes and output variables csv changes. Please double-check.

mjwitte · 2024-10-21T18:43:00Z

src/EnergyPlus/DXCoils.cc

-        state.dataOutRptPredefined->pdchVAVDXFanName = newPreDefColumn(state, state.dataOutRptPredefined->pdstVAVDXCoolCoil, "Assocated Fan");
+        state.dataOutRptPredefined->pdchVAVDXFanName = newPreDefColumn(state, state.dataOutRptPredefined->pdstVAVDXCoolCoil, "Associated Fan");


Affects output?

Yes

mjwitte · 2024-10-21T18:47:29Z

src/EnergyPlus/HeatRecovery.cc

-                                                     : (this->type == HVAC::HXType::Desiccant_Balanced ? "Dessicant Balanced" : "Generic"));
+                                                     : (this->type == HVAC::HXType::Desiccant_Balanced ? "Desiccant Balanced" : "Generic"));


Affects output?

Yes

mjwitte · 2024-10-21T18:49:39Z

src/EnergyPlus/HybridUnitaryAirConditioners.cc

-                            "Zone Hybrid Unitary HVAC DehumidificationLoad to Humidistat Setpoint Heat Tansfer Energy",
+                            "Zone Hybrid Unitary HVAC Dehumidification Load to Humidistat Setpoint Heat Transfer Energy",


Affects output?

Yes

mjwitte · 2024-10-21T18:50:10Z

src/EnergyPlus/HybridUnitaryAirConditioners.cc

-                            "Zone Hybrid Unitary HVAC Humidification Load to Humidistat Setpoint Heat Tansfer Energy",
+                            "Zone Hybrid Unitary HVAC Humidification Load to Humidistat Setpoint Heat Transfer Energy",


Affects output?

Yes

mjwitte · 2024-10-21T18:55:23Z

src/EnergyPlus/SteamBaseboardRadiator.cc

-                                                         "User-Speicified Maximum Steam Flow Rate [m3/s]",
+                                                         "User-Specified Maximum Steam Flow Rate [m3/s]",


Affects output?

Yes

mjwitte · 2024-10-21T18:55:49Z

src/EnergyPlus/SurfaceGeometry.cc

-              "Visible Reflectance,Surface Glazing Fraction,Surface Glazing Contruction\n");
+              "Visible Reflectance,Surface Glazing Fraction,Surface Glazing Construction\n");


Affects output?

Yes

mjwitte · 2024-10-21T18:57:19Z

src/EnergyPlus/ThermalComfort.cc

@@ -169,7 +169,7 @@ namespace ThermalComfort {
            CurrentGroupName = state.dataHeatBal->People(Loop).Name;

            // CurrentModuleObject='People'
-            // MJW MRT ToDo: Rename most Zone Therml Comfort output varibles to People Thermal Comfort ('cause they're keyed by People name)
+            // MJW MRT ToDo: Rename most Zone Thermal Comfort output variables to People Thermal Comfort ('cause they're keyed by People name)


Hmmm, "MJW" should follow up on this.

shorowit · 2024-10-21T20:24:48Z

@Myoldmopar @shorowit Sooo many changes, surprising, but no surprising.

I've added the output changes and output variables csv changes. Please double-check.

@mjwitte Yeah, I started off fixing one typo in HTML output and then went down a rabbit hole...

Your changes to OutputChanges24-2-0-to-25-1-0.md look reasonable to me, thanks for doing that. Should the ChillerAbsorption change ("Iniital" -> "Initial") be documented somewhere too? I can't immediately tell where that is output and I don't see it in any CI diffs.

mjwitte · 2024-10-21T20:32:22Z

Your changes to OutputChanges24-2-0-to-25-1-0.md look reasonable to me, thanks for doing that. Should the ChillerAbsorption change ("Iniital" -> "Initial") be documented somewhere too? I can't immediately tell where that is output and I don't see it in any CI diffs.

Yes, I missed that one. If I'm following the code correctly, you should see this if you turn on "Do HVAC Sizing Simulation" for a file that has a Chiller:Absorption.

github-actions · 2024-10-21T20:45:46Z

⚠️ Regressions detected on macos-14 for commit `d5d4268`

Regression Summary

Table Big Diffs: 23
Table String Diffs: 26
EIO: 8
ERR: 7
RDD: 1

mjwitte · 2024-10-24T22:15:03Z

@shorowit Took a few tries, but managed to produce the diff for the absorption chiller using
AbsorptionChiller-Autosized.idf.txt

The initial sizes are reported twice for some reason, but not important here.

Finished with this PR. @Myoldmopar ready for final review and merge.

github-actions · 2024-10-24T23:10:33Z

⚠️ Regressions detected on macos-14 for commit `3963c8a`

Regression Summary

Table Big Diffs: 23
Table String Diffs: 26
EIO: 8
ERR: 7
RDD: 1

shorowit added 5 commits September 23, 2024 08:49

Fix typos in docs.

5070ae8

Fix typos in idd.

3aefa29

Fix typos in src.

5c6ac38

Fix typos in tst.

831c957

Another bugfix.

3c2607f

shorowit added the DoNotPublish Includes changes that shouldn't be reported in the changelog label Sep 23, 2024

shorowit changed the title ~~Typos galore~~ Fix typos in docs/src/etc. Sep 23, 2024

shorowit commented Sep 23, 2024

View reviewed changes

shorowit added the Defect Includes code to repair a defect in EnergyPlus label Sep 23, 2024

shorowit added 3 commits September 23, 2024 10:41

More typos, apply clang.

7c02981

Fix in .hh too

b183b89

clang-format

de50c20

shorowit added the OutputChange Code changes output in such a way that it cannot be merged after IO freeze label Sep 23, 2024

shorowit marked this pull request as ready for review September 23, 2024 19:43

shorowit requested review from Myoldmopar and mjwitte September 23, 2024 19:47

shorowit added 3 commits September 27, 2024 17:12

Fix wrong name [ci skip]

6ff0170

Fix a few labels for bigladder html docs.

99bbedb

Merge branch 'develop' of https://github.com/NREL/EnergyPlus into typ…

0e314c0

…os_galore

shorowit changed the title ~~Fix typos in docs/src/etc.~~ Fix typos in outputs/docs/src/etc. Oct 10, 2024

mjwitte added IDDChange Code changes impact the IDD file (cannot be merged after IO freeze) and removed DoNotPublish Includes changes that shouldn't be reported in the changelog labels Oct 21, 2024

mjwitte added 2 commits October 21, 2024 14:03

Merge remote-tracking branch 'remotes/origin/develop' into typos_galore

1e48f45

Output changes

e9645a5

mjwitte approved these changes Oct 21, 2024

View reviewed changes

Output changes

1266e17

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix typos in outputs/docs/src/etc. #10760

Fix typos in outputs/docs/src/etc. #10760

shorowit commented Sep 23, 2024 •

edited

Loading

shorowit Sep 23, 2024

Myoldmopar Oct 15, 2024

shorowit Sep 23, 2024

mjwitte Oct 21, 2024

shorowit Sep 23, 2024

mjwitte Oct 21, 2024

shorowit Sep 23, 2024

mjwitte Oct 21, 2024

shorowit Sep 23, 2024

shorowit Sep 23, 2024

mjwitte Oct 21, 2024

shorowit Sep 23, 2024

mjwitte Oct 21, 2024

shorowit Sep 23, 2024

mjwitte Oct 21, 2024

github-actions bot commented Sep 23, 2024

github-actions bot commented Sep 23, 2024

shorowit commented Sep 23, 2024 •

edited

Loading

github-actions bot commented Oct 10, 2024

mjwitte left a comment

mjwitte Oct 21, 2024

mjwitte Oct 21, 2024

mjwitte Oct 21, 2024

mjwitte Oct 21, 2024

mjwitte Oct 21, 2024

mjwitte Oct 21, 2024

mjwitte Oct 21, 2024

shorowit commented Oct 21, 2024

mjwitte commented Oct 21, 2024 •

edited

Loading

github-actions bot commented Oct 21, 2024

mjwitte commented Oct 24, 2024

github-actions bot commented Oct 24, 2024

		"Iniital Design Size Design Generator Fluid Flow Rate [m3/s]",
		"Initial Design Size Design Generator Fluid Flow Rate [m3/s]",

		state.dataOutRptPredefined->pdchVAVDXFanName = newPreDefColumn(state, state.dataOutRptPredefined->pdstVAVDXCoolCoil, "Assocated Fan");
		state.dataOutRptPredefined->pdchVAVDXFanName = newPreDefColumn(state, state.dataOutRptPredefined->pdstVAVDXCoolCoil, "Associated Fan");

		: (this->type == HVAC::HXType::Desiccant_Balanced ? "Dessicant Balanced" : "Generic"));
		: (this->type == HVAC::HXType::Desiccant_Balanced ? "Desiccant Balanced" : "Generic"));

		"Zone Hybrid Unitary HVAC DehumidificationLoad to Humidistat Setpoint Heat Tansfer Energy",
		"Zone Hybrid Unitary HVAC Dehumidification Load to Humidistat Setpoint Heat Transfer Energy",

		"Zone Hybrid Unitary HVAC Humidification Load to Humidistat Setpoint Heat Tansfer Energy",
		"Zone Hybrid Unitary HVAC Humidification Load to Humidistat Setpoint Heat Transfer Energy",

		"User-Speicified Maximum Steam Flow Rate [m3/s]",
		"User-Specified Maximum Steam Flow Rate [m3/s]",

		"Visible Reflectance,Surface Glazing Fraction,Surface Glazing Contruction\n");
		"Visible Reflectance,Surface Glazing Fraction,Surface Glazing Construction\n");

Fix typos in outputs/docs/src/etc. #10760

Are you sure you want to change the base?

Fix typos in outputs/docs/src/etc. #10760

Conversation

shorowit commented Sep 23, 2024 • edited Loading

Pull request overview

Pull Request Author

Reviewer

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Sep 23, 2024

⚠️ Regressions detected on macos-14 for commit dbaffa3

github-actions bot commented Sep 23, 2024

⚠️ Regressions detected on macos-14 for commit e3dcda8

shorowit commented Sep 23, 2024 • edited Loading

github-actions bot commented Oct 10, 2024

⚠️ Regressions detected on macos-14 for commit 752e591

mjwitte left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

shorowit commented Oct 21, 2024

mjwitte commented Oct 21, 2024 • edited Loading

github-actions bot commented Oct 21, 2024

⚠️ Regressions detected on macos-14 for commit d5d4268

mjwitte commented Oct 24, 2024

github-actions bot commented Oct 24, 2024

⚠️ Regressions detected on macos-14 for commit 3963c8a

shorowit commented Sep 23, 2024 •

edited

Loading

⚠️ Regressions detected on macos-14 for commit `dbaffa3`

⚠️ Regressions detected on macos-14 for commit `e3dcda8`

shorowit commented Sep 23, 2024 •

edited

Loading

⚠️ Regressions detected on macos-14 for commit `752e591`

mjwitte commented Oct 21, 2024 •

edited

Loading

⚠️ Regressions detected on macos-14 for commit `d5d4268`

⚠️ Regressions detected on macos-14 for commit `3963c8a`