merge architecture to selected buildings

[ShiZhongming]

Summary by CodeRabbit

• New Features

  • Updated metrics for energy demand and emissions to a more user-friendly boolean toggle format.
  • Expanded options for district heating and cooling systems.
  • Introduced new parameters for enhanced optimization processes.

• Documentation

  • Added help descriptions for various parameters to improve user understanding.

• Bug Fixes

  • Improved clarity and maintainability of the codebase through variable renaming and restructuring.

[coderabbitai]

Walkthrough

The pull request introduces significant modifications to the configuration file cea/default.config and the Python script cea/import_export/result_summary.py. The configuration file updates various metrics related to energy demand and emissions from a multi-choice format to boolean parameters, enhancing configurability. New parameters for district heating and cooling systems are also added. In the Python script, variable renaming and function restructuring improve code clarity and maintainability, with new functions introduced for metric retrieval.

Changes

File Path	Change Summary
cea/default.config	- Metrics for energy demand, emissions, and solar systems changed from MultiChoiceParameter to BooleanParameter. - New parameters added for optimization: cooling-components, heating-components, heat-rejection-components, maximum-number-of-networks, objective-functions, generate-detailed-outputs, retain-run-results. - Help descriptions added for clarity.
cea/import_export/result_summary.py	- Variables renamed for clarity: main_use_r to main_use_ratio, year to construction_year, standard to construction_standard. - New functions added for retrieving metrics: get_list_list_metrics_with_date, get_list_list_metrics_without_date, get_list_list_metrics_building. - Minor comment adjustments for consistency.

Possibly related PRs

• Pv analytics by building #3731: The changes in cea/import_export/result_summary.py related to the aggregation of building data metrics may connect with the modifications in the main PR that update metrics parameters in the configuration file, as both involve handling and processing energy-related metrics.

🐰 In the meadow, changes bloom,
Metrics shift, dispelling gloom.
Boolean toggles, clear and bright,
Configs dance in morning light.
Code refines, clarity's grace,
A greener path we now embrace! 🌱

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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. (Experiment)
• @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.

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.

[coderabbitai]

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (2)

cea/default.config (1)

775-827: LGTM! Consider adding documentation for the metrics configuration change.

The conversion from multi-choice to boolean parameters improves configurability by allowing independent control of each metric. The help descriptions are clear and comprehensive.

Consider adding a note in the documentation about this configuration change from multi-choice to boolean parameters, as it may affect existing scripts that use the old configuration format.

cea/import_export/result_summary.py (1)

1955-2020: LGTM! Well-organized metric categorization and helper functions.

The new helper functions and metric list definitions improve code organization and maintainability. They align well with the new boolean configuration parameters.

Consider adding docstrings to the new helper functions (get_list_list_metrics_with_date, get_list_list_metrics_without_date, get_list_list_metrics_building) to document their purpose and return values.

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 5a83755 and f3311e8.

📒 Files selected for processing (2)

• cea/default.config (1 hunks)
• cea/import_export/result_summary.py (9 hunks)

🔇 Additional comments (3)

cea/import_export/result_summary.py (3)

1301-1301: LGTM! Variable renaming improves code clarity.

The renaming of variables to more descriptive names (main_use_ratio, construction_year, construction_standard) improves code readability and better reflects their purpose.

Also applies to: 1315-1316

---

1347-1347: LGTM! Filter functions consistently updated with new variable names.

The filter functions have been properly updated to use the new variable names, maintaining code consistency throughout the codebase.

Also applies to: 1373-1373, 1425-1425

---

Line range hint 2040-2070: LGTM! Main function effectively integrates new configuration and building handling.

The main function has been properly updated to handle the new configuration parameters and building filtering functionality. The changes align well with the PR objective of merging architecture to selected buildings.