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

Add currentSimTime to API #8811

Merged
merged 5 commits into from
Jun 21, 2021
Merged

Add currentSimTime to API #8811

merged 5 commits into from
Jun 21, 2021

Conversation

mitchute
Copy link
Collaborator

@mitchute mitchute commented Jun 9, 2021

Pull request overview

  • Add an API method to access the current sim time, as referenced from the start of the environment.

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

…hours, referenced from the start of the environment
@mitchute mitchute added NewFeature Includes code to add a new feature to EnergyPlus APIChange Code changes impact the Python Plugins, C API or Python API Bindings labels Jun 9, 2021
@mitchute mitchute added this to the EnergyPlus 9.6 Release milestone Jun 9, 2021
@mitchute mitchute requested a review from Myoldmopar June 9, 2021 18:45
@mitchute mitchute self-assigned this Jun 9, 2021
@mitchute
Copy link
Collaborator Author

mitchute commented Jun 9, 2021

@Myoldmopar maybe we need a "NonBreakingAPIChange" GH label for instances like this?

@Myoldmopar
Copy link
Member

I'd be OK with another label if it is helpful, much more concerned about PRs that break the API being highlighted than PRs that add to it. Could you add a call to the new C and Python endpoints in the tst/EnergyPlus/api/* files to exercise the new functions? I think it would be ready to go in after that. Thanks, this is a great little addition!

@Myoldmopar
Copy link
Member

Awesome all around, thanks @mitchute!! If CI ever wakes up out of the Queued state then we'll get this merged.

@Myoldmopar
Copy link
Member

The Actions issues could be related to a known issue encountered today:
image

@Myoldmopar
Copy link
Member

No need to wait on integration to finish, this was good before your final tidying up commits. Thanks for cleaning up the little doc warnings as well! Merging.

@Myoldmopar Myoldmopar merged commit 31e1fbd into develop Jun 21, 2021
@Myoldmopar Myoldmopar deleted the add-to-api-current-sim-time branch June 21, 2021 20:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
APIChange Code changes impact the Python Plugins, C API or Python API Bindings NewFeature Includes code to add a new feature to EnergyPlus
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants