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

DE use_types schedule and properties fix #3762

Merged
merged 6 commits into from
Feb 3, 2025

Conversation

kleme66
Copy link
Contributor

@kleme66 kleme66 commented Jan 21, 2025

Hi, @ddceruti and I have been working on the DE use_types:

  • Multiple load comfort and properties have been adjusted based on the reference.
  • 1P_OFFICE, KINDERGARDEN, SENIOR_RES and SEMINAR use types have been deleted.
  • Office and Foodstore water/occupancy schedule have been changed.
  • Documentation updated.

Summary by CodeRabbit

  • Documentation

    • Significantly revised German Building Stock Database documentation.
    • Updated naming conventions for residential building profiles from D_SFH and D_MFH to SINGLE_RES and MULTI_RES.
    • Introduced a new section detailing non-residential building types and their limited data.
    • Expanded use type properties section with specific parameters for non-residential types.
    • Updated authors' section to include Urbano Tataranni and modified various references for clarity.
  • Chores

    • Clarified descriptions for peak specific fresh water consumption and adjusted indoor comfort properties.

Indoor_comfort temperature swapped
Complete use type properties fixed, adapted to the reference
Deleted unnecessary use_types. Fixed some occupation and water schedules. Documentation updated
Copy link

coderabbitai bot commented Jan 21, 2025

Important

Review skipped

Review was skipped due to path filters

⛔ Files ignored due to path filters (1)
  • cea/databases/DE/archetypes/use_types/SEMINAR.csv is excluded by !**/*.csv

CodeRabbit blocks several paths by default. You can override this behavior by explicitly including those paths in the path filters. For example, including **/dist/** will override the default block on the dist directory, by removing the pattern from both the lists.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The pull request focuses on updating the documentation for the German Building Stock Database in the cea/databases/DE/documentation.md file. The changes include revising naming conventions for residential profiles, introducing a new section for non-residential building types, expanding use type properties, updating internal loads and indoor comfort properties sections, and adding a new author to the documentation.

Changes

File Changes
cea/databases/DE/documentation.md - Updated residential profile naming from D_SFH to SINGLE_RES and D_MFH to MULTI_RES
- Added new section for non-residential building types
- Expanded use type properties with non-residential parameters
- Updated internal loads and indoor comfort properties sections
- Added author Urbano Tataranni

Possibly related PRs

  • Update README.md with DOI #3758: This PR is related as it also updates the authors' section to include Urbano Tataranni, similar to the main PR, and it modifies documentation to enhance clarity and accuracy.

Poem

🏠 In databases of German might,

Profiles renamed with scholarly light,

From SFH to SINGLE, MFH to MULTI's grace,

Non-residential types now find their space,

A rabbit's documentation dance! 🐰📚


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🧹 Nitpick comments (5)
cea/databases/DE/documentation.md (5)

165-170: Fix grammatical and formatting issues in the non-residential section.

The section has some grammatical and formatting issues:

  1. "there are non residential use types included" is unclear and grammatically incorrect
  2. "non residential" should be hyphenated as "non-residential"
  3. The sentence structure in the paragraph about DIN/TS 18599 could be improved

Apply these changes:

-In the current status, there are non residential use types included. There is only a very heterogeneous data basis for non-residential buildings in Germany:
+Currently, non-residential use types are included. The data basis for non-residential buildings in Germany is heterogeneous:

-DIN/TS 18599 (e.g. Teil 13: Tabulation method for non-residential buildings): Also describes many occupancy profiles, but against the background of simplified calculation in the course of energy consulting. In this case, a simplified monthly balance procedure is usually used. However, the different thermal zones of a building are taken into account.
+DIN/TS 18599 (e.g. Teil 13: Tabulation method for non-residential buildings): Describes many occupancy profiles in the context of simplified calculations for energy consulting. It uses a simplified monthly balance procedure that considers different thermal zones of a building.
🧰 Tools
🪛 LanguageTool

[misspelling] ~165-~165: This expression is normally spelled as one or with a hyphen.
Context: ...types In the current status, there are non residential use types included. There is only a ver...

(EN_COMPOUNDS_NON_RESIDENTIAL)


[style] ~167-~167: ‘taken into account’ might be wordy. Consider a shorter alternative.
Context: ...fferent thermal zones of a building are taken into account. For this reason, the values cannot be ...

(EN_WORDINESS_PREMIUM_TAKEN_INTO_ACCOUNT)


[typographical] ~170-~170: The word “otherwise” is an adverb that can’t be used like a conjunction, and therefore needs to be separated from the sentence.
Context: ...is was added to the USE_TYPE_PROPERTIES excel, otherwise it was assumed to be equal to CH defaul...

(THUS_SENTENCE)


170-170: Improve clarity of the data source statement.

The sentence about data sources needs better structure and punctuation.

Apply this change:

-So, if the data is available in DIN 18599-13, this was added to the USE_TYPE_PROPERTIES excel, otherwise it was assumed to be equal to CH defaults. 
+If data is available in DIN 18599-13, it has been added to the USE_TYPE_PROPERTIES excel; otherwise, CH defaults are used.
🧰 Tools
🪛 LanguageTool

[typographical] ~170-~170: The word “otherwise” is an adverb that can’t be used like a conjunction, and therefore needs to be separated from the sentence.
Context: ...is was added to the USE_TYPE_PROPERTIES excel, otherwise it was assumed to be equal to CH defaul...

(THUS_SENTENCE)


187-188: Improve readability of heating setpoint documentation.

The heating setpoint documentation contains multiple standards without clear differentiation of their applicability.

Apply this change:

-| `Ths_set_C` |   Setpoint temperature for heating system (refers to "code") | DIN EN 16798-1:2022-03 Tab.NA.3  Wohnen Kat. I: 20°C AND DIN V 18599-10:2018-10 Tab. 4 Auslegungstemperatur Heizfall and DIN EN 18599-13 Tab. 8 if available, CH defaults otherwise |
+| `Ths_set_C` |   Setpoint temperature for heating system (refers to "code") | Primary: DIN EN 16798-1:2022-03 Tab.NA.3 Wohnen Kat. I (20°C); Additional references: DIN V 18599-10:2018-10 Tab. 4 and DIN EN 18599-13 Tab. 8 (if available), otherwise CH defaults |

204-211: Standardize internal load calculation formatting.

The internal load calculations section lacks consistent formatting and units.

Apply these changes:

  1. Use consistent unit formatting (l/d/p vs l/p/d)
  2. Use consistent capitalization at the start of each line
  3. Remove trailing spaces and fix line breaks
-- Water usage School with shower: 250 Wh/m2/d $\times$ 3 m2/p / 23.28 Wh/l at 20 K temperature difference = 32.22 l/d/p [18599-13].
-- Water usage School with shower: 10.95 l/p/d [18599-13].
-- Assumed cold water usage equal to warmwater usage in School.
-- Warm water usage in office assumed equal to 2.5 l/p/d according to paper 'Fuentes, Elena, L. Arce, and Jaume Salom. "A review of domestic hot water consumption profiles for application in systems and buildings energy performance analysis." Renewable and Sustainable Energy Reviews 81 (2018): 1530-1547.
-- Restaurant assumed to be equal to: "Bürogebäude mit
-Gaststätte" of DIN 18599-13 -> 1500*1.2/23.28=77 l/d/p, cold water assumed equal.
-- Hotel left equal to CH.
-- Library: 30*5/23.28=6.44.
+- School with shower (water usage): 32.22 l/p/d [18599-13] (calculated as 250 Wh/m²/d × 3 m²/p / 23.28 Wh/l at 20 K temperature difference)
+- School with shower (alternative): 10.95 l/p/d [18599-13]
+- School cold water usage: Equal to warm water usage
+- Office warm water usage: 2.5 l/p/d [Fuentes et al., 2018]
+- Restaurant: 77 l/p/d (based on "Bürogebäude mit Gaststätte" from DIN 18599-13, calculated as 1500×1.2/23.28); cold water assumed equal
+- Hotel: Equal to CH defaults
+- Library: 6.44 l/p/d (calculated as 30×5/23.28)

426-426: Fix reference formatting.

The BDEW reference lacks proper citation details.

Apply this change:

-[^BDEW] : Bundesverbands der Energie- und Wasserwirtschaft
+[^BDEW]: Bundesverband der Energie- und Wasserwirtschaft (BDEW). "Trinkwasserverwendung im Haushalt." Available at: https://www.bdew.de/. Last accessed: [add access date]
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 07f7688 and 1ea60fd.

⛔ Files ignored due to path filters (6)
  • cea/databases/DE/archetypes/use_types/FOODSTORE.csv is excluded by !**/*.csv
  • cea/databases/DE/archetypes/use_types/KINDERGARDEN.csv is excluded by !**/*.csv
  • cea/databases/DE/archetypes/use_types/OFFICE.csv is excluded by !**/*.csv
  • cea/databases/DE/archetypes/use_types/OFFICE_1P.csv is excluded by !**/*.csv
  • cea/databases/DE/archetypes/use_types/SENIOR_RES.csv is excluded by !**/*.csv
  • cea/databases/DE/archetypes/use_types/USE_TYPE_PROPERTIES.xlsx is excluded by !**/*.xlsx
📒 Files selected for processing (1)
  • cea/databases/DE/documentation.md (3 hunks)
🧰 Additional context used
🪛 LanguageTool
cea/databases/DE/documentation.md

[misspelling] ~165-~165: This expression is normally spelled as one or with a hyphen.
Context: ...types In the current status, there are non residential use types included. There is only a ver...

(EN_COMPOUNDS_NON_RESIDENTIAL)


[style] ~167-~167: ‘taken into account’ might be wordy. Consider a shorter alternative.
Context: ...fferent thermal zones of a building are taken into account. For this reason, the values cannot be ...

(EN_WORDINESS_PREMIUM_TAKEN_INTO_ACCOUNT)


[typographical] ~170-~170: The word “otherwise” is an adverb that can’t be used like a conjunction, and therefore needs to be separated from the sentence.
Context: ...is was added to the USE_TYPE_PROPERTIES excel, otherwise it was assumed to be equal to CH defaul...

(THUS_SENTENCE)


[misspelling] ~195-~195: This expression is normally spelled as one or with a hyphen.
Context: ... EN 16798 and DIN18599 for Residential. Non residential assumed equal to CH. | | APPLIENCES | 0...

(EN_COMPOUNDS_NON_RESIDENTIAL)


[typographical] ~199-~199: If you want to indicate numerical ranges or time ranges, consider using an en dash.
Context: ...599-10:2018 Tab. 4 Nutzungszeit von 6:00 - 23:00 | | SETBACK | if not SETPOINT| ...

(DASH_RULE)

🔇 Additional comments (1)
cea/databases/DE/documentation.md (1)

158-161: LGTM: Clear naming convention update for residential profiles.

The change from D_SFH to SINGLE_RES and D_MFH to MULTI_RES improves clarity and maintainability by using more descriptive names.


| Parameter | Description | Method |
|--- |--- |--- |
| `Occ_m2P` | Occupancy density (refers to “code”) | According to Sagner: 48 m2 per person for house owner (SFH) and 35m2 per Person in rented flats (MFH) |
| `El_Wm2` | Peak specific electrical load due to artificial lighting (refers to “code”)| DIN V 18599-4 Anhang B (Abbildung B.12) = 6,4 W/m² |
| `Vw_ldp` | Peak specific fresh water consumption (refers to “code”) | average water consumption for Germany, 42% of 121 lpd [^BDEW] |
| `Vw_ldp` | Peak specific fresh water consumption (refers to “code”) | average water consumption for Germany [^BDEW] |
Copy link

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Remove outdated reference to average water consumption.

The line mentions "average water consumption for Germany" but references only the BDEW abbreviation without providing specific values or citation details.

Consider adding specific consumption values and proper citation, or remove the reference if the data is not being used.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (2)
cea/databases/DE/documentation.md (2)

167-167: Consider rephrasing for conciseness.

The phrase "are taken into account" could be simplified to "are considered" for better readability.

-However, the different thermal zones of a building are taken into account.
+However, the different thermal zones of a building are considered.
🧰 Tools
🪛 LanguageTool

[style] ~167-~167: ‘taken into account’ might be wordy. Consider a shorter alternative.
Context: ...fferent thermal zones of a building are taken into account. For this reason, the values cannot be ...

(EN_WORDINESS_PREMIUM_TAKEN_INTO_ACCOUNT)


195-199: Fix formatting inconsistencies.

Two formatting issues to address:

  1. "Non residential" should be hyphenated as "Non-residential"
  2. Time range should use an en dash instead of a hyphen (6:00–23:00)
🧰 Tools
🪛 LanguageTool

[misspelling] ~195-~195: This expression is normally spelled as one or with a hyphen.
Context: ... EN 16798 and DIN18599 for Residential. Non residential assumed equal to CH. | | APPLIENCES | 0...

(EN_COMPOUNDS_NON_RESIDENTIAL)


[typographical] ~199-~199: If you want to indicate numerical ranges or time ranges, consider using an en dash.
Context: ...599-10:2018 Tab. 4 Nutzungszeit von 6:00 - 23:00 | | SETBACK | if not SETPOINT| ...

(DASH_RULE)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 1ea60fd and 59ed5f2.

📒 Files selected for processing (1)
  • cea/databases/DE/documentation.md (3 hunks)
🧰 Additional context used
🪛 LanguageTool
cea/databases/DE/documentation.md

[style] ~167-~167: ‘taken into account’ might be wordy. Consider a shorter alternative.
Context: ...fferent thermal zones of a building are taken into account. For this reason, the values cannot be ...

(EN_WORDINESS_PREMIUM_TAKEN_INTO_ACCOUNT)


[misspelling] ~195-~195: This expression is normally spelled as one or with a hyphen.
Context: ... EN 16798 and DIN18599 for Residential. Non residential assumed equal to CH. | | APPLIENCES | 0...

(EN_COMPOUNDS_NON_RESIDENTIAL)


[typographical] ~199-~199: If you want to indicate numerical ranges or time ranges, consider using an en dash.
Context: ...599-10:2018 Tab. 4 Nutzungszeit von 6:00 - 23:00 | | SETBACK | if not SETPOINT| ...

(DASH_RULE)

⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: windows-latest
  • GitHub Check: macos-latest
  • GitHub Check: ubuntu-latest
🔇 Additional comments (6)
cea/databases/DE/documentation.md (6)

160-161: LGTM! Clear and descriptive naming convention.

The change from abbreviated forms (D_SFH, D_MFH) to more descriptive names (SINGLE_RES, MULTI_RES) improves readability and understanding.


178-178: Remove outdated reference to average water consumption.

The line mentions "average water consumption for Germany" but references only the BDEW abbreviation without providing specific values or citation details.

Consider adding specific consumption values and proper citation, or remove the reference if the data is not being used.


187-188: LGTM! Well-documented temperature setpoints.

The heating setpoint and setback temperatures are clearly defined with proper references to DIN standards.


204-211: LGTM! Well-documented water usage calculations.

The water usage calculations for different building types are clearly presented with proper units and references.


409-409: LGTM! Author addition.

New author added to the documentation.


426-426: LGTM! Well-formatted references.

New references added with proper citations.

@ShiZhongming ShiZhongming self-requested a review January 22, 2025 09:19
@ShiZhongming ShiZhongming merged commit e27b238 into architecture-building-systems:master Feb 3, 2025
6 checks passed
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.

2 participants