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

Replace "iterative" scaling parameter since it is deprecated #208

Merged
merged 2 commits into from
Dec 12, 2024

Conversation

vbochetRTE
Copy link
Contributor

@vbochetRTE vbochetRTE commented Dec 5, 2024

Please check if the PR fulfills these requirements (please use '[x]' to check the checkboxes, or submit the PR and then click the checkboxes)

  • The commit message follows our guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)

Does this PR already have an issue describing the problem ? If so, link to this issue using '#XXX' and skip the rest

What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)

What is the current behavior? (You can also link to an open issue here)

What is the new behavior (if this is a feature change)?

Does this PR introduce a breaking change? (What changes might users need to make in their application due to this PR?)

Other information:

(if any of the questions/checkboxes don't apply, please delete them entirely)

Summary by CodeRabbit

  • New Features

    • Enhanced scaling operations with prioritized settings for network shifts, particularly for Italy.
    • Added warning logs for discrepancies in shift values.
  • Bug Fixes

    • Improved error handling and logging during the scaling process.
  • Chores

    • Updated the version of the farao.dichotomy dependency to 4.22.1.

Copy link

coderabbitai bot commented Dec 5, 2024

Walkthrough

The changes in this pull request involve updates to the InitialShiftService class and the pom.xml file. The InitialShiftService class has modifications in the shiftNetwork method, specifically in how ScalingParameters are instantiated and how logging and calculations are handled for shifts in Italy. Additionally, the version number for the farao.dichotomy dependency has been updated from 4.22.0 to 4.22.1 in the pom.xml file, affecting the project's dependency management.

Changes

File Change Summary
cse-cc-import-runner-app/src/main/java/com/farao_community/farao/cse/import_runner/app/services/InitialShiftService.java Updated shiftNetwork method to instantiate ScalingParameters with priority set to RESPECT_OF_VOLUME_ASKED, added warning log for done vs asked difference, and introduced a limitation splitting factor for Italy. Enhanced error handling and logging.
pom.xml Updated version of farao.dichotomy dependency from 4.22.0 to 4.22.1.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant InitialShiftService
    participant ScalingParameters

    User->>InitialShiftService: Call shiftNetwork()
    InitialShiftService->>ScalingParameters: Instantiate with RESPECT_OF_VOLUME_ASKED
    InitialShiftService->>InitialShiftService: Check done vs asked
    alt If zone ID is Italy
        InitialShiftService->>InitialShiftService: Calculate limitation splitting factor
        InitialShiftService->>ScalingParameters: Apply scaling values
    end
    InitialShiftService->>User: Return result
Loading

🐰 "In the land of code where rabbits hop,
Changes abound, we never stop!
Scaling parameters now take flight,
With logs and limits, all feels right.
Version updated, dependencies aligned,
Hopping forward, new paths we find!" 🐇


📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between da4daf0 and 25289fa.

📒 Files selected for processing (2)
  • cse-cc-import-runner-app/src/main/java/com/farao_community/farao/cse/import_runner/app/services/InitialShiftService.java (1 hunks)
  • pom.xml (1 hunks)
🔇 Additional comments (3)
cse-cc-import-runner-app/src/main/java/com/farao_community/farao/cse/import_runner/app/services/InitialShiftService.java (2)

98-100: LGTM: Good replacement for deprecated 'iterative' parameter

The change to use RESPECT_OF_VOLUME_ASKED priority is an appropriate replacement for the deprecated 'iterative' parameter, as it better expresses the intent to respect the requested scaling volumes.


Line range hint 98-124: Verify the impact of GLSK limitation handling

The new GLSK limitation handling for Italy introduces proportional adjustment of shifts. While the logic is sound, we should verify that this behavior is expected by stakeholders.

Let's check for any related test cases or documentation:

pom.xml (1)

54-54: Verify farao-dichotomy 4.22.1 release notes

The version update to 4.22.1 was suggested in PR comments. Let's verify the changes in this version.


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. (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.

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.

danielthirion
danielthirion previously approved these changes Dec 5, 2024
@kahyami
Copy link
Collaborator

kahyami commented Dec 11, 2024

upgrade farao-dichotomy version

@kahyami kahyami merged commit a77139e into master Dec 12, 2024
4 checks passed
@kahyami kahyami deleted the replace-iterative-scaling-parameter branch December 12, 2024 11:08
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