Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Correction of Various Errors in the Tips and Tricks Documentation #7857

Merged
merged 1 commit into from
Mar 16, 2020
Merged

Correction of Various Errors in the Tips and Tricks Documentation #7857

merged 1 commit into from
Mar 16, 2020

Conversation

RKStrand
Copy link
Contributor

Pull request overview

  • Fixes Scrub references to Example File Generator from documentation #7833
  • A variety of problems were noted in Tips and Tricks. Some of these were web sites that were no longer valid. Others were glaring formatting issues. In some cases, minor language edits were made (like where a chapter was totally blank). While this was not a full clean-up of the document, it looks much better and all of the hyperlinks should now work and point to the correct address.

Pull Request Author

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

  • Title of PR should be user-synopsis style (clearly understandable in a standalone changelog context)
  • Label the PR with at least one of: Defect, Refactoring, NewFeature, Performance, and/or DoNoPublish
  • Pull requests that impact EnergyPlus code must also include unit tests to cover enhancement or defect repair
  • Author should provide a "walkthrough" of relevant code changes using a GitHub code review comment process
  • If any diffs are expected, author must demonstrate they are justified using plots and descriptions
  • If changes fix a defect, the fix should be demonstrated in plots and descriptions
  • If any defect files are updated to a more recent version, upload new versions here or on DevSupport
  • If IDD requires transition, transition source, rules, ExpandObjects, and IDFs must be updated, and add IDDChange label
  • If structural output changes, add to output rules file and add OutputChange label
  • If adding/removing any LaTeX docs or figures, update that document's CMakeLists file dependencies

Reviewer

This will not be exhaustively relevant to every PR.

  • Perform a Code Review on GitHub
  • If branch is behind develop, merge develop and build locally to check for side effects of the merge
  • If defect, verify by running develop branch and reproducing defect, then running PR and reproducing fix
  • If feature, test running new feature, try creative ways to break it
  • CI status: all green or justified
  • Check that performance is not impacted (CI Linux results include performance check)
  • Run Unit Test(s) locally
  • Check any new function arguments for performance impacts
  • Verify IDF naming conventions and styles, memos and notes and defaults
  • If new idf included, locally check the err file and other outputs

@RKStrand
Correction of various errors in document
42524cc 
A variety of problems were noted in Tips and Tricks.  Some of these were web sites that were no longer valid.  Others were glaring formatting issues.  In some cases, minor language edits were made (like where a chapter was totally blank).  While this was not a full clean-up of the document, it looks much better and all of the hyperlinks should now work and point to the correct address.
@RKStrand RKStrand added Defect Includes code to repair a defect in EnergyPlus Documentation Related primarily on the LaTeX-based EnergyPlus documentation labels Mar 13, 2020
@RKStrand RKStrand requested review from Myoldmopar and mjwitte March 13, 2020 20:00
@RKStrand RKStrand self-assigned this Mar 13, 2020
@Myoldmopar
Copy link
Member

This seems like a good set of straightforward changes. I will build locally but I don't have any problems. And CI is happy of course, with one ERR file that is quite unrelated 😆 .

Myoldmopar
Myoldmopar approved these changes Mar 16, 2020
View reviewed changes
Copy link
Member

@Myoldmopar Myoldmopar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good to go. Built locally, all changes look fine.

...energyplus/src/building-geometry-shading-zone-model/using-multipliers-zone-and-or-window.tex
San Francisco & 0:50 & 1:34 & 9:59 \tabularnewline
Colorado & 0:51 & 1:40 & 10:31 \tabularnewline
Tampa & 0:51 & 1:36 & 10:05 \tabularnewline
Washington DC & 0:51 & 1:36 & 9:48 \tabularnewline
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tables look much nicer here.

...ips-and-tricks-using-energyplus/src/design-day-weather-data/weather-data-for-simulations.tex
@@ -4,4 +4,4 @@ \section{Weather Data for Simulations}\label{weather-data-for-simulations}

Drury B. Crawley. 1998. ``Which Weather Data Should You Use for Energy Simulations of Commercial Buildings?'' in ASHRAE Transactions, pp.~498-515, Vol. 104, Pt. 2. Atlanta: ASHRAE. (PDF 197 KB)

PDF: \url{http://energyplus.gov/pdfs/bibliography/whichweatherdatashouldyouuseforenergysimulations.pdf}
Click \href{https://energyplus.net/sites/all/modules/custom/weather/weather_files/whichweatherdatashouldyouuseforenergysimulations.pdf}{here} for the PDF of the above paper.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Works for me.

.../hvac-sizing-equipment-simulation-and-controls/variable-refrigerant-flow-air-conditioner.tex
@@ -1,6 +1,6 @@
\section{Variable Refrigerant Flow Air Conditioner}\label{variable-refrigerant-flow-air-conditioner}

\textbf{\emph{The EnergyPlus v7.0 release (October 2011) includes an initial model for VRF systems.~ See AirConditioner:VariableRefrigerantFlow and related objects.}}
\textbf{\emph{Since its V7.0 release (October 2011), EnergyPlus has included a model for VRF systems.~ See AirConditioner:VariableRefrigerantFlow and related objects.}}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Better wording for sure.

doc/tips-and-tricks-using-energyplus/src/input/getting-data-from-window-program.tex
@@ -20,7 +20,9 @@ \subsection{WINDOW Data File}\label{window-data-file}

Please note that there is a bug in WINDOW 5 that causes two of the lines in the EnergyPlus data file to be joined. This bug is fixed in versions of Window 5.02 (and above). To be sure, you can check the data file for a line that looks like:

GLAZING SYSTEM OPTICAL DATAAngle~~~~ 0~~~ 10~~~ 20~~~ 30~~~ 40~~~ 50~~~ 60~~~ 70~~~ 80~~~ 90 Hemis
GLAZING SYSTEM OPTICAL DATA
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

doc/tips-and-tricks-using-energyplus/src/utilities.tex
@@ -1 +1,3 @@
\chapter{Utilities}\label{utilities}

EnergyPlus comes with a wide variety of pre- and post-processing that are found in the PreProcess and PostProcess folders in the main EnergyPlus install folder. These utilities have been developed since the initial release of EnergyPlus and can be helpful during the creation of input data for EnergyPlus or interpreting its output.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah that'll be better than nothing...literally!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I know! 😂😂😂 How long has this been like this?🤦‍♂️ Thanks for reviewing this!

@Myoldmopar Myoldmopar merged commit 4a24233 into develop Mar 16, 2020
@Myoldmopar Myoldmopar deleted the 7833CleanUpTipsAndTricksDocumentation branch March 16, 2020 12:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Myoldmopar Myoldmopar Myoldmopar approved these changes

@mjwitte mjwitte Awaiting requested review from mjwitte

Assignees

@RKStrand RKStrand

Labels
Defect Includes code to repair a defect in EnergyPlus Documentation Related primarily on the LaTeX-based EnergyPlus documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Scrub references to Example File Generator from documentation
5 participants
@RKStrand @Myoldmopar @nrel-bot @nrel-bot-3 @nrel-bot-2b