equinor/ert

Add basic validations to ForwardModelStepPlugin such as executable exists

Open

#8,779 opened on Sep 24, 2024

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Python (136 forks)auto 404
good first issuemaintenanceneeds-discussion

Repository metrics

Stars
 (157 stars)
PR merge metrics
 (PR metrics pending)

Description

What happened? (You can include a screenshot if it helps explain)

A user can create a ForwardModelStepPlugin to use in Ert with a bad path to an executable, and this will not be validated before it blows up mid run. Discuss whether we should add this validation or not, or whether this is Ert's responsibility in the ForwardModelStepPlugin constructor, or the FM implementor's responsibility through the ForwardModelStepPlugin.validate_pre_experiment(...) api.

It should at most be a warning, because there can be forward models preceding this one that creates the necessary files/executables.

See previous discussion under PR: https://github.com/equinor/ert/pull/8735

What did you expect to happen?

Warning if a non existent executable is provided, with a explanation that it might be ok

steps to reproduce

Create a forward model step plugin with a bad executable.

Environment where bug has been observed

  • python 3.8
  • python 3.9
  • python 3.10
  • python 3.11
  • python 3.12
  • macosx
  • rhel7
  • rhel8
  • local queue
  • lsf queue
  • slurm queue
  • openPBS queue
  • used flag --enable-scheduler

Contributor guide

Research direction
Inspect the ForwardModelStepPlugin constructor in the codebase, add a check for the executable path using os.path.exists or pathlib.Path.exists, and issue a warning via logging.warning if the path does not exist.
Tech stack
python
Domain
backend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Python
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70