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

More ruby documentation #1784

Merged
merged 27 commits into from
Aug 16, 2024
Merged

More ruby documentation #1784

merged 27 commits into from
Aug 16, 2024

Conversation

joseph-robertson
Copy link
Collaborator

@joseph-robertson joseph-robertson commented Jul 23, 2024

Pull Request Description

Addresses #1759 (pv.rb, battery.rb, generator.rb, location.rb).

Also moves default schedule data from HPXMLtoOpenStudio/resources/schedules.rb to HPXMLtoOpenStudio/resources/data/default_schedules.csv. The hpxml_defaults.rb file then parses (once) this data file for defaulting weekday/weekend fractions and monthly multipliers. The docs also reference this file instead of hardcoding/duplicating weekday/weekend fractions and monthly multipliers (a new helper script is created for facilitating this).

Also moves schedules from BuildResidentialScheduleFile/resources/constants.rb to BuildResidentialScheduleFile/resources/schedules.csv. The schedules.rb file then parses (once) this data file for using fractions and monthly multipliers. The README.md file is updated with the information contained in schedules_config.md.

Checklist

Not all may apply:

  • Schematron validator (EPvalidator.xml) has been updated
  • Sample files have been added/updated (openstudio tasks.rb update_hpxmls)
  • Tests have been added/updated (e.g., HPXMLtoOpenStudio/tests/test*.rb and/or workflow/tests/test*.rb)
  • Documentation has been updated
  • Changelog has been updated
  • openstudio tasks.rb update_measures has been run
  • No unexpected changes to simulation results of sample files

Comment on lines +83 to +85
### `<enduse>_event_duration_probability.csv`

TODO
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

This was missing in the README; we'll need to get this TODO filled in.

Copy link
Contributor

Choose a reason for hiding this comment

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

Should we revisit/reconsider having different monthly multipliers here?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

(This file renamed to schedules.csv.)

Comment on lines +2 to +6
lighting_interior,LightingInteriorMonthlyMultipliers,"1.075, 1.064951905, 1.0375, 1.0, 0.9625, 0.935048095, 0.925, 0.935048095, 0.9625, 1.0, 1.0375, 1.064951905",
dishwasher,HotWaterDishwasherMonthlyMultiplier,"1.083, 1.056, 1.023, 0.999, 0.975, 0.944, 0.918, 0.928, 0.938, 0.984, 1.059, 1.094",
clothes_washer,HotWaterClothesWasherMonthlyMultiplier,"0.968, 1.013, 0.99, 1.034, 1.019, 1.015, 1.048, 1, 1.021, 0.949, 0.945, 0.999",
clothes_dryer,ClothesDryerMonthlyMultiplier,"1.09, 1.054, 1.044, 0.996, 0.992, 0.967, 0.931, 0.906, 0.923, 0.955, 1.035, 1.108",
cooking_range,CookingMonthlyMultiplier,"1.038, 1.026, 0.976, 0.945, 0.965, 0.947, 0.939, 0.965, 0.967, 1.006, 1.098, 1.129",
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Can we get these data sources filled in?

Copy link
Collaborator Author

@joseph-robertson joseph-robertson Aug 6, 2024

Choose a reason for hiding this comment

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

Comment on lines +102 to +111
#### Plug Loads

This is the baseline schedule for misc plugload, lighting and ceiling fan.
It will be modified based on occupancy.
Television plugload uses the same schedule as misc plugload.

#### Lighting

Indoor lighting schedule is generated on the fly.
Garage lighting uses the same schedule as indoor lighting.
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Revisit whether this is still true?

@joseph-robertson joseph-robertson marked this pull request as ready for review August 8, 2024 17:55
.github/workflows/config.yml Outdated Show resolved Hide resolved
HPXMLtoOpenStudio/resources/hpxml_defaults.rb Outdated Show resolved Hide resolved
Copy link
Contributor

@shorowit shorowit left a comment

Choose a reason for hiding this comment

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

Looks good. Thanks, @joseph-robertson! Will merge when the CI comes back green.

@shorowit shorowit merged commit 77657cf into master Aug 16, 2024
7 checks passed
@shorowit shorowit deleted the ruby-docs branch August 16, 2024 22:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

2 participants