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

[Capacity update] US + minor change to EIA capacity parser #6354

Merged
9 commits merged into from
Jan 16, 2024

Conversation

ghost
Copy link

@ghost ghost commented Jan 16, 2024

Issue

New capacity data needed to filter out flaky EIA parser data

Description

Update to EIA parser so that we have capacity for all production modes
Update US yaml files with capacity data from 2023-10-01

Preview

Double check

  • I have tested my parser changes locally with poetry run test_parser "zone_key"
  • I have run pnpx prettier --write . and poetry run format to format my changes.

@github-actions github-actions bot added python Pull requests that update Python code zone config Pull request or issue for zone configurations capacity parser labels Jan 16, 2024
Copy link
Contributor

PR Analysis

  • 🎯 Main theme: Updating US capacity data and making minor changes to EIA capacity parser
  • 📝 PR summary: This PR updates the capacity data for various US zones and makes minor changes to the EIA capacity parser to accommodate all production modes. The capacity data is updated with information from 2023-10-01.
  • 📌 Type of PR: Enhancement
  • 🧪 Relevant tests added: No
  • ⏱️ Estimated effort to review [1-5]: 3, because the PR involves changes in multiple files and requires domain knowledge to understand the changes in capacity data and the EIA parser.
  • 🔒 Security concerns: No security concerns found

PR Feedback

💡 General suggestions: The PR is well-structured and the changes are clear. However, it would be beneficial to include tests that validate the new capacity data and the changes made to the EIA parser.

🤖 Code feedback:
relevant fileelectricitymap/contrib/capacity_parsers/EIA.py
suggestion      

Consider using a more descriptive variable name than mode_dict. The name should reflect the purpose or content of the dictionary. [medium]

relevant linemode_dict = {}

relevant filescripts/update_capacity_configuration.py
suggestion      

It would be helpful to add a comment explaining why the check if zone in ZONES_CONFIG: is necessary. This would improve code readability. [medium]

relevant lineif zone in ZONES_CONFIG:

relevant fileconfig/zones/US-MIDW-MISO.yaml
suggestion      

Ensure that the capacity data is accurate and up-to-date. Regularly updating this data will ensure the system's accuracy. [important]

relevant linebattery storage:

relevant fileelectricitymap/contrib/capacity_parsers/EIA.py
suggestion      

Consider adding error handling for cases where the mode is not found in CAPACITY_MODES. This will make the code more robust. [important]

relevant linefor mode in CAPACITY_MODES:


✨ Usage guide:

Overview:
The review tool scans the PR code changes, and generates a PR review. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on any PR.
When commenting, to edit configurations related to the review tool (pr_reviewer section), use the following template:

/review --pr_reviewer.some_config1=... --pr_reviewer.some_config2=...

With a configuration file, use the following template:

[pr_reviewer]
some_config1=...
some_config2=...
Utilizing extra instructions

The review tool can be configured with extra instructions, which can be used to guide the model to a feedback tailored to the needs of your project.

Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Specify the relevant sub-tool, and the relevant aspects of the PR that you want to emphasize.

Examples for extra instructions:

[pr_reviewer] # /review #
extra_instructions="""
In the code feedback section, emphasize the following:
- Does the code logic cover relevant edge cases?
- Is the code logic clear and easy to understand?
- Is the code logic efficient?
...
"""

Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.

How to enable\disable automation
  • When you first install PR-Agent app, the default mode for the review tool is:
pr_commands = ["/review", ...]

meaning the review tool will run automatically on every PR, with the default configuration.
Edit this field to enable/disable the tool, or to change the used configurations

About the 'Code feedback' section

The review tool provides several type of feedbacks, one of them is code suggestions.
If you are interested only in the code suggestions, it is recommended to use the improve feature instead, since it dedicated only to code suggestions, and usually gives better results.
Use the review tool if you want to get a more comprehensive feedback, which includes code suggestions as well.

Auto-labels

The review tool can auto-generate two specific types of labels for a PR:

  • a possible security issue label, that detects possible security issues (enable_review_labels_security flag)
  • a Review effort [1-5]: x label, where x is the estimated effort to review the PR (enable_review_labels_effort flag)
Extra sub-tools

The review tool provides a collection of possible feedbacks about a PR.
It is recommended to review the possible options, and choose the ones relevant for your use case.
Some of the feature that are disabled by default are quite useful, and should be considered for enabling. For example:
require_score_review, require_soc2_review, enable_review_labels_effort, and more.

More PR-Agent commands

To invoke the PR-Agent, add a comment using one of the following commands:

  • /review: Request a review of your Pull Request.
  • /describe: Update the PR title and description based on the contents of the PR.
  • /improve [--extended]: Suggest code improvements. Extended mode provides a higher quality feedback.
  • /ask <QUESTION>: Ask a question about the PR.
  • /update_changelog: Update the changelog based on the PR's contents.
  • /add_docs 💎: Generate docstring for new components introduced in the PR.
  • /generate_labels 💎: Generate labels for the PR based on the PR's contents.
  • /analyze 💎: Automatically analyzes the PR, and presents changes walkthrough for each component.

See the tools guide for more details.
To list the possible configuration parameters, add a /config comment.

See the review usage page for a comprehensive guide on using this tool.

Copy link
Author

Choose a reason for hiding this comment

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

Manually reallocated oil as gas because there is apparently only gas production from EIA parser

config/zones/US-NW-GRID.yaml Outdated Show resolved Hide resolved
@ghost
Copy link
Author

ghost commented Jan 16, 2024

@VIKTORVAV99 i'm reviewing all the values now, will merge after. :)

@VIKTORVAV99
Copy link
Member

@VIKTORVAV99 i'm reviewing all the values now, will merge after. :)

Don't forget to run prettier, otherwise it won't let you merge.

Easiest way would be pnpx prettier@2 --write . in the top level repo.

@ghost ghost merged commit 4348b51 into master Jan 16, 2024
19 checks passed
@ghost ghost deleted the md/update-us-capacities branch January 16, 2024 12:52
ghost pushed a commit that referenced this pull request Jan 24, 2024
* US capacity data + update to parser

* add rounding

* some mode reallocation

* manual reallocation FLA-HST

* manual adjustmen

* manual adjustment SW-PNM

* prettier

* update capacity model

* format

---------

Co-authored-by: Mathilde Daugy <mathilde.daugy@electricitymaps.com>
This pull request was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
capacity parser python Pull requests that update Python code zone config Pull request or issue for zone configurations
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant