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.

Sign up for GitHub

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

Jump to bottom

replace ecl2df with res2df #244

Closed
wants to merge 2 commits into from
Closed

replace ecl2df with res2df #244

wants to merge 2 commits into from

Conversation

asnyv
Copy link
Collaborator

@asnyv asnyv commented Jan 30, 2024

closes #243

@codecov-commenter
Copy link

codecov-commenter commented Jan 30, 2024 •
edited
Loading

Codecov Report

Attention: Patch coverage is 50.00000% with 4 lines in your changes are missing coverage. Please review.

Project coverage is 83.52%. Comparing base (ab3f4d7) to head (db7e5b6).
Report is 1 commits behind head on master.

❗ Current head db7e5b6 differs from pull request most recent head fb79ba9. Consider uploading reports for the commit fb79ba9 to get more accurate results

Files Patch % Lines
src/fmu/ensemble/realization.py 50.00% 4 Missing ⚠️
Additional details and impacted files 
@@           Coverage Diff           @@
##           master     #244   +/-   ##
=======================================
  Coverage   83.52%   83.52%           
=======================================
  Files          14       14           
  Lines        3072     3072           
=======================================
  Hits         2566     2566           
  Misses        506      506

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@asnyv asnyv marked this pull request as ready for review March 13, 2024 12:42
@asnyv asnyv requested review from berland and eivindjahren March 13, 2024 12:45
eivindjahren
eivindjahren approved these changes Mar 13, 2024
View reviewed changes
Copy link
Contributor

@eivindjahren eivindjahren left a comment

Choose a reason for hiding this comment

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

👍

@asnyv
Copy link
Collaborator Author

asnyv commented Mar 13, 2024

@eivindjahren @berland
After thinking a bit more: This is technically a breaking change as the get_eclfiles function for ScratchRealization is replaced with get_resdatafiles.
I doubt a lot of users use ScratchRealization directly, but should maybe have a deprecation period?

@eivindjahren
Copy link
Contributor

eivindjahren commented Mar 13, 2024 •
edited
Loading

@asnyv That seems reasonable. Maybe you can create an "alias" and then add a deprecation warning to it?

eivindjahren
eivindjahren reviewed Apr 4, 2024
View reviewed changes
src/fmu/ensemble/realization.py
@@ -866,10 +866,10 @@ def get_eclfiles(self):
>>> real.find_files("eclipse/model/MYMODELPREDICTION.DATA")

Returns:
ecl2df.EclFiles. None if nothing found
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe copy this function for now, and expose both but with a deprecation warning added to get_eclfiles. You can then have two import checks: HAVE_ECL2DF and HAVE_RES2DF.

Copy link
Contributor

Choose a reason for hiding this comment

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

Does this resolve the problem of breaking changes @asnyv ?

@eivindjahren
Copy link
Contributor

This issue should be resolved now. Feel free to reopen the PR if it is not :) .

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@eivindjahren eivindjahren eivindjahren approved these changes

@berland berland Awaiting requested review from berland

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

ecl2df has been renamed to res2df
3 participants
@asnyv @codecov-commenter @eivindjahren