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.

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

Switch to E+ Space FT by default #4589

Merged
merged 4 commits into from May 19, 2022
Merged

Switch to E+ Space FT by default #4589

merged 4 commits into from May 19, 2022

Conversation

joseph-robertson
Copy link
Collaborator

Pull request overview

Pull Request Author

  • Model API Changes / Additions
  • Any new or modified fields have been implemented in the EnergyPlus ForwardTranslator (and ReverseTranslator as appropriate)
  • Model API methods are tested (in src/model/test)
  • EnergyPlus ForwardTranslator Tests (in src/energyplus/Test)
  • If a new object or method, added a test in NREL/OpenStudio-resources: Add Link
  • If needed, added VersionTranslation rules for the objects (src/osversion/VersionTranslator.cpp)
  • Verified that C# bindings built fine on Windows, partial classes used as needed, etc.
  • All new and existing tests passes
  • If methods have been deprecated, update rest of code to use the new methods

Labels:

  • If change to an IDD file, add the label IDDChange
  • If breaking existing API, add the label APIChange
  • If deemed ready, add label Pull Request - Ready for CI so that CI builds your PR

Review Checklist

This will not be exhaustively relevant to every PR.

  • Perform a Code Review on GitHub
  • Code Style, strip trailing whitespace, etc.
  • All related changes have been implemented: model changes, model tests, FT changes, FT tests, VersionTranslation, OS App
  • Labeling is ok
  • 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

@joseph-robertson joseph-robertson added Enhancement Request component - CLI Pull Request - Ready for CI This pull request if finalized and is ready for continuous integration verification prior to merge. labels May 17, 2022
@joseph-robertson joseph-robertson self-assigned this May 17, 2022
@joseph-robertson joseph-robertson marked this pull request as ready for review May 17, 2022 17:34
Copy link
Collaborator

@jmarrec jmarrec left a comment

Choose a reason for hiding this comment

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

Switch the bool flag to use the space translation, and bump to 3.4.1

LGTM!

@@ -40,7 +40,7 @@ OS:Version,
\required-field
A2, \field Version Identifier
\type alpha
\default 3.3.1
\default 3.4.1
Copy link
Collaborator

Choose a reason for hiding this comment

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

ouch, that was wrong defore (which isn't too big of a deal)

@@ -120,7 +120,7 @@ namespace energyplus {
m_excludeSQliteOutputReport = false;
m_excludeHTMLOutputReport = false;
m_excludeVariableDictionary = false;
m_excludeSpaceTranslation = true;
m_excludeSpaceTranslation = false; // At 3.4.1, this was changed to false.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Actual change

@jmarrec
Copy link
Collaborator

jmarrec commented May 19, 2022

I started a Release Notes template, and tried to address the Windows test that failed:

[ RUN      ] EnergyPlusFixture.ForwardTranslator_SpaceInfiltrationDesignFlowRate_SpaceTypes
D:\jenkins\openstudio\develop\src\energyplus\Test\SpaceInfiltrationDesignFlowRate_GTest.cpp(245): error: Expected equality of these values:
  0.687
  totalInfiltration
    Which is: 0.687

@jmarrec
Copy link
Collaborator

jmarrec commented May 19, 2022

I'm merging, but will check on the Windows runner to see if the test passed. Can be addressed on develop if needed

@jmarrec jmarrec merged commit 6b968d5 into develop May 19, 2022
@jmarrec jmarrec deleted the space-ft-default branch May 19, 2022 11:24
Comment on lines +70 to +73
* [#4589](https://github.com/NREL/OpenStudio/pull/4589) - Switch to E+ Space FT by default
* OpenStudio SDK 3.3.0 added support to the new EnergyPlus 9.6.0 [space concept](https://github.com/NREL/EnergyPlus/blob/develop/design/FY2021/NFP-Spaces.md). This was an opt-in feature, as it was disabled by default.
* This is now enabled by default. You can opt-out by by manually calling `ForwardTranslator::setExcludeSpaceTranslation(true)` before calling `ForwardTranslator::translateModel(Model&)` or passing the CLI argument `--no-space-translation` to the `run` method (eg: `openstudio run --no-space-translation -w workflow.osw`)
* As a reminder, a few limitations due to DaylightingControls/IlluminanceMap exist: in case one of these objects is found in a ThermalZone, spaces will be combined for that ThermalZone (historical behavior)
Copy link
Collaborator

Choose a reason for hiding this comment

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

Document the change in the Release Notes

@@ -242,7 +242,7 @@ TEST_F(EnergyPlusFixture, ForwardTranslator_SpaceInfiltrationDesignFlowRate_Spac
}
}

EXPECT_EQ(0.687, totalInfiltration);
EXPECT_DOUBLE_EQ(0.687, totalInfiltration);
Copy link
Collaborator

Choose a reason for hiding this comment

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

Try to address windows runner failed test

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component - CLI Enhancement Request Pull Request - Ready for CI This pull request if finalized and is ready for continuous integration verification prior to merge.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Switch to E+ Space FT by default
3 participants