search

architecture-building-systems / CityEnergyAnalyst

The City Energy Analyst (CEA)
https://www.cityenergyanalyst.com/
MIT License
197 stars 66 forks source link

Enable user to import weather file as .dat #3713

Open Mar-Ges opened 5 days ago

Mar-Ges commented 5 days ago

Hi all, This update is especially for anyone using data from the German Weather Agency (DWD), which provides weather files in this format.

Summary by CodeRabbit

Release Notes

coderabbitai[bot] commented 5 days ago

Walkthrough

The pull request introduces several significant changes across multiple files. The WeatherPathParameter class in cea/config.py has been updated to handle .dat files, converting them to .epw format. A new script for generating weather data sources has been added in cea/datamanagement/weather_helper/generate_weather_data_sources.py. Additionally, a new function for parsing .dat files has been introduced in cea/datamanagement/weather_helper/weather_helper.py. The configuration file cea/default.config has also been modified to support new parameters and update existing ones for enhanced flexibility.

Changes

File Path Change Summary
cea/config.py Modified decode method in WeatherPathParameter to handle .dat files and convert them to .epw. Updated error message for valid formats.
cea/datamanagement/weather_helper/generate_weather_data_sources.py Introduced a new script to generate weather data sources from Excel files, processing them into GeoJSON format.
cea/datamanagement/weather_helper/weather_helper.py Added parse_dat_weather_file function to convert .dat files to .epw. Modified main function to incorporate this new functionality.
cea/default.config Updated weather parameter to accept .epw and .dat, added year-construction parameter, and modified occupancy-type options. Marked several parameters as nullable.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Config
    participant WeatherPathParameter
    participant WeatherHelper
    participant GenerateWeatherDataSources

    User->>Config: Specify weather file
    Config->>WeatherPathParameter: Check file type
    WeatherPathParameter->>WeatherHelper: If .dat, call parse_dat_weather_file
    WeatherHelper->>WeatherHelper: Convert .dat to .epw
    WeatherPathParameter->>Config: Validate file paths
    User->>GenerateWeatherDataSources: Request weather data sources
    GenerateWeatherDataSources->>GenerateWeatherDataSources: Fetch and process Excel files
    GenerateWeatherDataSources->>User: Provide GeoJSON output

Poem

🐰 In the meadow where data flows,
A .dat file now brightly glows.
With a hop and a skip, it turns to .epw,
Weather paths broaden, oh what a view!
Configs updated, choices galore,
Let's gather the data, and explore some more! 🌼

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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
🪧 Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , 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 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://docs.coderabbit.ai) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.