equinor/ert

Add basic validations to ForwardModelStepPlugin such as executable exists

Open

#8.779 aberto em 24 de set. de 2024

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

Métricas do repositório

Stars
 (157 stars)
Métricas de merge de PR
 (Métricas PR pendentes)

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

Guia do colaborador

Direção de pesquisa
Inspecione o construtor do ForwardModelStepPlugin no código, adicione uma verificação para o caminho do executável usando os.path.exists ou pathlib.Path.exists e emita um aviso via logging.warning se o caminho não existir.
Pilha de tecnologia
python
Domain
backend
Tipo Issue
Funcionalidade
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Python
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
70