Documentation Issues 2024b

[Sashadf1]

Issue overview (add additional documentation issues as separate comments below).

• Typo in E+ documentation (I/O reference) for Site:GroundTemperature:BuildingSurface. Correct "The object is options if you have no surfaces with ground contact." to instead say "The object is optional if you have no surfaces with ground contact."

Details

Some additional details for this issue (if relevant):

• Version of EnergyPlus - 24.1

[mjwitte]

• Documentation typo in 1.5.16 SimulationControl
  Change "Or the user might have all flow rates and equipment sizes already specified and desire an annual weather without any preceding sizing calculations." to instead say "Or the user might have all flow rates and equipment sizes already specified and desire an annual weather simulation without any preceding sizing calculations."

TLDR there is a missing "simulation" noun.
(moved here from #10606)

[Sashadf1]

I will add any other documentation typos I find to this thread.

[mjwitte]

From helpdesk ticket 16741

In the auxiliary Programs document, page 27 table 2.9, the shortname 'dirnozrad' is a typo. It's unclear if it should be 'dirnormrad' (which seemed to work when I used it) and is what is in figure 8. Figure 7 just has 'dirnorrad'.

• In table 2.9
  dirnozrad --> dirnormrad
  dirnorzillum --> dirnormillum

For reference, here are the header rows from an epw converted to the special csv format.

Date,HH:MM,Datasource,DryBulb {C},DewPoint {C},RelHum {%},Atmos Pressure {Pa},ExtHorzRad {Wh/m2},ExtDirRad {Wh/m2},HorzIRSky {Wh/m2},GloHorzRad {Wh/m2},DirNormRad {Wh/m2},DifHorzRad {Wh/m2},GloHorzIllum {lux},DirNormIllum {lux},DifHorzIllum {lux},ZenLum {Cd/m2},WindDir {deg},WindSpd {m/s},TotSkyCvr {.1},OpaqSkyCvr {.1},Visibility {km},Ceiling Hgt {m},PresWeathObs,PresWeathCodes,Precip Wtr {mm},Aerosol Opt Depth {.001},SnowDepth {cm},Days Last Snow,Albedo {.01},Rain {mm},Rain Quantity {hr}
Date,HH:MM,Datasource,Dry Bulb Temperature {C},Dew Point Temperature {C},Relative Humidity {%},Atmospheric Pressure {Pa},Extraterrestrial Horizontal Radiation {Wh/m2},Extraterrestrial Direct Normal Radiation {Wh/m2},Horizontal Infrared Radiation Intensity from Sky {Wh/m2},Global Horizontal Radiation {Wh/m2},Direct Normal Radiation {Wh/m2},Diffuse Horizontal Radiation {Wh/m2},Global Horizontal Illuminance {lux},Direct Normal Illuminance {lux},Diffuse Horizontal Illuminance {lux},Zenith Luminance {Cd/m2},Wind Direction {deg},Wind Speed {m/s},Total Sky Cover {.1},Opaque Sky Cover {.1},Visibility {km},Ceiling Height {m},Present Weather Observation,Present Weather Codes,Precipitable Water {mm},Aerosol Optical Depth {.001},Snow Depth {cm},Days Since Last Snow,Albedo {.01},Liquid Precipitation Depth {mm},Liquid Precipitation Quantity {hr}

• Also, throughout the auxiliary programs doc, every occurrence of \_ should be simply _ when it appears in a code list format. Searching the pdf shows these. I'm not sure if that sequence appears correctly elsewhere in the source file(s). e.g. from p. 34, Figure 6. DEF file for formatted custom file.

[mjwitte]

• From Helpdesk ticket 16744.
  The Input Output Reference for ChillerHeaterPerformance:Electric:EIR says:

1.23.30.18 Field: Condenser Type
This alpha field contains the type of condenser. WaterCooled is the only valid type, and it requires the
full specification of the condenser loop and its associated equipment.

But the IDD shows two options:

  A3 , \field Condenser Type
       \type choice
       \key AirCooled
       \key WaterCooled
       \default WaterCooled

[jmarrec]

• ScheduleFile Column Separator mentions Fixed, but IDD says Space

EnergyPlus/doc/input-output-reference/src/overview/group-schedules.tex

Lines 489 to 491 in a7fe8f7

	\paragraph{Field: Column Separator}\label{field-column-separator-001}
	This field specifies the character used to separate columns of data if the file has more than one column. The choices are: Comma, Tab, Fixed (spaces fill each column to a fixed width), or Semicolon. The default is Comma.

Schedule:File,
[...]
  A4 , \field Column Separator
       \type choice
       \key Comma
       \key Tab
       \key Space
       \key Semicolon
       \default Comma

[rraustad]

• IO Ref Sizing:Zone idf snippet is out of date. Does not show SAT Input Method or Temperature Difference inputs:

  Sizing:Zone ,
  SPACE5 -1, !- Name of a zone
  14., !- Zone cooling design supply air temperature {C}
  50., !- Zone heating design supply air temperature {C}
  0.009, !- Zone cooling design supply air humidity ratio {kg-H2O/kg-air}
  0.004, !- Zone heating design supply air humidity ratio {kg-H2O/kg-air}
  DSOA1 , !- Design Specification Outdoor Air Object Name

[mjwitte]

• In the EMS Application Guide, the examples show an old form for EnergyManagementSystem:OutputVariable where the units are part of the variable name.

Using this form results in a warning:

The current object has a separate field for units.

  EnergyManagementSystem:OutputVariable,
    Weighted Average Building Zone Air Temperature,  !- Name
    AverageBuildingTemp,     !- EMS Variable Name
    Averaged,                !- Type of Data in Variable
    ZoneTimeStep,            !- Update Frequency
    ,                        !- EMS Program or Subroutine Name
    C;                       !- Units

Ref helpdesk ticket 16759.

[mjwitte]

• See Typo in Ideal Air Loads Input Output Reference #10833

[mjwitte]

• See Typo in Section 1.17.1 ZoneInfiltration:DesignFlowRate #10835

[Sashadf1]

Should say "0.0, the local wind speed..." for full sentence.