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

Support for custom HPXMLs #212

Merged
merged 5 commits into from
May 5, 2022
Merged

Support for custom HPXMLs #212

merged 5 commits into from
May 5, 2022

Conversation

joseph-robertson
Copy link
Contributor

@joseph-robertson joseph-robertson commented Feb 28, 2022

Pull Request Description

Adds optional hpxml_directory field at the feature level.

Questions:

  • if supplied, do we want to throw error if any other input-related fields are provided (e.g., floor_area, number_of_stories, etc.)?

Checklist (Delete lines that don't apply)

  • Unit tests have been added or updated
  • Documentation has been modified appropriately
  • All ci tests pass (green)
  • An issue has been created (which will be used for the changelog)
  • This branch is up-to-date with develop

@DavidGoldwasser
Copy link
Collaborator

@rawadelkontar do you have thoughts about this related to reporting. I know we still need the GeoJSON footprint, and ideally the footprint area matches that. I see number of floors I thought that with floor to floor height would be used to shade adjacent structures (when enabled). I don't see floor to floor or total building height, in my features, but maybe there is default used.

@joseph-robertson
Copy link
Contributor Author

We need to decide which of these required inputs become optional (or even excluded) if hpxml_directory is supplied. They would become optional because they are parsed from HPXML files in the populated hpxml_directory field.

In theory they all could remain as required, and then be used for error-checking against HPXML files in hpxml_directory. For example, total up all the floor area represented by the HPXML files, and check against floor_area at the feature (building) level. Or sum all the HPXML files and check against number_of_residential_units.

@kflemin @DavidGoldwasser

@joseph-robertson joseph-robertson marked this pull request as ready for review May 5, 2022 18:00
@joseph-robertson joseph-robertson requested a review from kflemin May 5, 2022 18:10
Copy link
Contributor

@kflemin kflemin 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!

@kflemin kflemin merged commit 5cb2954 into develop May 5, 2022
@kflemin kflemin deleted the custom-hpxmls branch May 5, 2022 19:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants