Add Occupant Types Data

[jiangyilin123]

Description

Adding the occupant types data into the database aims to capture diverse behavioral patterns and create a representative dataset that enables users to improve the building energy modeling and advance research on dynamic occupant behavior using OpenStudio.

Note that this initial design of the occupant types database focuses specifically on office space types and has not yet been integrated into OpenStudio-Standards yet.

Type of change

Specifically, we add support_occupant_types.py,support_occupant_energy_behavior.py, and support_occupant_energy_behavior.py under database_tables. The JSON files corresponding to these data have also been added. Additionally, we included more schedules in the support_schedules.json, which is used to represent occupant schedules in office buildings. The documents have also been updated to explain the occupant types in the database.

• [ ] Bug fix (non-breaking change which fixes an issue)
• [x] New feature (non-breaking change which adds functionality)
• [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
• [x] This change requires a documentation update

How Has This Been Tested?

Using the existing unit tests and existing functions, we can generate an occupant type dataset, create openstudio.db, export database data into csv or json format, and generate OpenStudio-Standards Data.

• [x] Unit test pass locally with my changes
• [x] openstudio.db created with no error with my changes
• [x] csv and json dataset can be exported with no error
• [x] json file correctly generated under local openstudio

Test Configuration:
Python 3.12

Checklist:

• [x] My code follows the style guidelines of this project
• [x] I have performed a self-review of my own code
• [x] I have commented my code, particularly in hard-to-understand areas
• [x] I have made corresponding changes to the documentation
• [x] My changes generate no new warnings
• [x] I used previous tests to prove my fix is effective or that my feature works
• [x] Existing unit tests pass locally with my changes
• [x] Any dependent changes have been merged and published in downstream modules

[jiangyilin123]

Hi PNNL team, We have submitted a pull request to add occupant-type data. We updated the documents (Structure. md) to explain our dataset. Is this appropriate? If not, we can have a separate document for this.

[lymereJ]

@jiangyilin123 - Thanks a lot for your submission! Do you need it to be merged before the end of the month? Which version of Black are you using to do the formatting?

[jiangyilin123]

@jiangyilin123 - Thanks a lot for your submission! Do you need it to be merged before the end of the month? Which version of Black are you using to do the formatting?

Hi. The following is my environment:
black, 24.8.0 (compiled: yes) Python (CPython) 3.12.3

[lymereJ]

We're currently using version 22.12.0 of Black. Are you able to try it with that version?

[jiangyilin123]

We're currently using version 22.12.0 of Black. Are you able to try it with that version

Hi @lymereJ , it would be ideal to merge this submission by the end of this month as it is our FY24 delivery. If that's not possible, merging it before the next expected official release date is another alternative. Thanks!

[jiangyilin123]

Hi @lymereJ , I am addressing all other comments. Just need a bit more time.

[jiangyilin123]

Hi Weili and Jeremy. Thank you for the comments. I made changes based on your comments. However, there are still several mentions of OpenStudio or openstudio-standard in Strucutre.md file, which were written by the original author, so I left them untouched. Please let me know if there are any other changes required. If not, it's ready to be merged.

[lymereJ]

All good, we can address them later! Thanks!