NatLabRockies / NatLabRockies/OpenStudio

Port openstudio-standards Informative Schedule Methods to C++

Open
#4,965 3 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Enhancement Request Triage
Dominant language
C++
Stars
646
Forks
237
Avg merge
3d 11h
Merged PRs (30d)
10

Description

Enhancement Request

Add several methods to the Schedule object that report useful schedule information

Detailed Description

There are several methods in the extension gem and openstudio-standards that require gathering information about a schedule, such as the schedule runtime minimum and maximum values, the design day(s) minimum and maximum values, equivalent full load hours, and a vector of runtime hourly values.

A short list:

  • Schedule runtime minimum value
  • Schedule runtime maximum value
  • Schedule summer design day minimum value
  • Schedule summer design day maximum value
  • Schedule winter design day minimum value
  • Schedule winter design day maximum value
  • Schedule runtime equivalent full-load hours
  • Schedule values (hourly, or with an argument of 'hourly' or 'timestep')

Other fields welcome, but the above are the most common.

There are already methods in openstudio-standards that provide this functionality, so perhaps it isn't necessary in OpenStudio SDK. But there may be other developers who would make use of the fields in the OpenStudio SDK.

Possible Implementation

I suggest implementing this method as part of the base Schedule class, which will need to be defined for each kind of schedule child object.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the Schedule base class and its schedule child objects, then review the existing implementations in the extension gem and openstudio-standards. Done means the listed runtime, design-day, equivalent-full-load-hour, and hourly or timestep value methods are available across the relevant Schedule types.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
backend-api-design
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.