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

Allow users without equilibrium to run ert with FLOW simulator. #8324

Merged
merged 6 commits into from
Aug 20, 2024

Conversation

DanSava
Copy link
Contributor

@DanSava DanSava commented Jul 17, 2024

Issue
Resolves #8223

Approach
Create flow_config.yml config file if it is not found in the env variables.

  • PR title captures the intent of the changes, and is fitting for release notes.
  • Added appropriate release note label
  • Commit history is consistent and clean, in line with the contribution guidelines.
  • Make sure tests pass locally (after every commit!)

When applicable

  • When there are user facing changes: Updated documentation
  • New behavior or changes to existing untested code: Ensured that unit tests are added (See Ground Rules).
  • Large PR: Prepare changes in small commits for more convenient review
  • Bug fix: Add regression test for the bug
  • Bug fix: Create Backport PR to latest release

@DanSava DanSava self-assigned this Jul 17, 2024
@DanSava DanSava force-pushed the run_flow_with_no_flow_confing branch from c2be884 to 55edaa2 Compare July 17, 2024 06:58
@codecov-commenter
Copy link

codecov-commenter commented Jul 17, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.63%. Comparing base (221fea2) to head (3714b41).
Report is 4 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #8324      +/-   ##
==========================================
+ Coverage   90.60%   90.63%   +0.03%     
==========================================
  Files         342      342              
  Lines       20898    20906       +8     
==========================================
+ Hits        18935    18949      +14     
+ Misses       1963     1957       -6     
Flag Coverage Δ
gui-tests 75.87% <ø> (+0.01%) ⬆️
integration-tests 54.04% <ø> (-0.04%) ⬇️
unit-tests 68.75% <ø> (+0.04%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

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

Copy link
Contributor

@yngve-sk yngve-sk left a comment

Choose a reason for hiding this comment

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

Thanks for your patience with the questions. I think overall this looks good, could you also add some documentation so that this new behavior is described in the docs? (The current FLOW documentation does look a bit vague tbh, so if you feel like revising it a bit more that would be great). You could just write it into the Flow ForwardModelStepPlugin @ ert/shared/hook_implementations/forward_model_steps.py

@DanSava DanSava force-pushed the run_flow_with_no_flow_confing branch from 55edaa2 to 0957bc2 Compare August 2, 2024 12:44
@DanSava DanSava requested a review from yngve-sk August 2, 2024 12:44
@DanSava
Copy link
Contributor Author

DanSava commented Aug 2, 2024

could you also add some documentation so that this new behavior is described in the docs? (The current FLOW documentation does look a bit vague tbh, so if you feel like revising it a bit more that would be great). You could just write it into the Flow ForwardModelStepPlugin @ ert/shared/hook_implementations/forward_model_steps.py

I added a bit of information to ert/shared/hook_implementations/forward_model_steps.py but not very much. The behaviour this PR is adding is not new it just allows a user that has flow installed on their machine to use it without having to create their own flow_config.yml

We will need to expand on this documentation once and if we decide to support additional options. But currently without using a user-defined forward model job for flow ERT only supports the default options in a flow run.

@DanSava DanSava requested a review from sondreso August 8, 2024 08:45
@DanSava DanSava force-pushed the run_flow_with_no_flow_confing branch from 0957bc2 to ffa6632 Compare August 12, 2024 07:13
@DanSava DanSava force-pushed the run_flow_with_no_flow_confing branch from ffa6632 to 6806191 Compare August 15, 2024 08:27
@sondreso
Copy link
Collaborator

sondreso commented Aug 15, 2024

Could we also create an example in test-data/ for running with flow? (Similar to this, just a complete example people could use as a starting point) Then we could also run that example as part of our tests!

@DanSava DanSava force-pushed the run_flow_with_no_flow_confing branch from 6806191 to 286ed25 Compare August 20, 2024 09:23
@DanSava DanSava force-pushed the run_flow_with_no_flow_confing branch from 286ed25 to 4f97b05 Compare August 20, 2024 09:24
Copy link
Collaborator

@sondreso sondreso left a comment

Choose a reason for hiding this comment

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

Very nice 💯

@DanSava DanSava merged commit ddf23d1 into equinor:main Aug 20, 2024
35 checks passed
@DanSava DanSava deleted the run_flow_with_no_flow_confing branch August 20, 2024 13:30
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.

How to configure a FLOW forward model simulation and to run the test cases in ert/test-data/eclipse ?
5 participants