Skip to content

DOC : Update HOOK_WORKFLOW_JOB documentation - #1877

Open
nourinmohd wants to merge 1 commit into
equinor:mainfrom
nourinmohd:1816_update_hook_doc
Open

nourinmohd wants to merge 1 commit into
equinor:mainfrom
nourinmohd:1816_update_hook_doc

Conversation

@nourinmohd

Copy link
Copy Markdown
Contributor

Resolves #1816

Updated getting_started.md to:

  • Use HOOK_WORKFLOW_JOB directly.
  • Remove the separate workflow file instructions.
  • Use the argument-free WF_CREATE_CASE_METADATA "--sumo" form.
  • Link to ERT documentation.

Checklist

  • Tests added (if not, comment why)
  • Test coverage equal or up from main (run pytest with --cov=src/ --cov-report term-missing)
  • If not squash merging, every commit passes tests
  • Appropriate commit prefix and precise commit message used
  • All debug prints and unnecessary comments removed
  • Docstrings are correct and updated
  • Documentation is updated, if necessary
  • Latest main rebased/merged into branch
  • Added comments on this PR where appropriate to help reviewers
  • Moved issue status on project board
  • Checked the boxes in this checklist ✅

@nourinmohd
nourinmohd requested review from GibranAlfa and tnatt October 5, 2026 08:12
@GibranAlfa
GibranAlfa removed their request for review October 5, 2026 08:22

@tnatt tnatt left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Nice change 🙂 one suggestion added below

Comment on lines +103 to +104
The `"--sumo"` argument is optional. When it is included, `<SUMO_CASEPATH>`
must be defined in the ERT config.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Suggest adding a typical example of how to define the casepath. Also lets make it more clear that we want people to use Sumo 🙂

Suggested change
The `"--sumo"` argument is optional. When it is included, `<SUMO_CASEPATH>`
must be defined in the ERT config.
The `"--sumo"` argument is recommended and is used to register the case in Sumo. If specified, `<SUMO_CASEPATH>` must be defined in the ERT config, for example:
DEFINE <SUMO_CASEPATH> <SCRATCH>/<USER>/<CASE_DIR>

case metadata are used to register the case. Case metadata are made by a
hooked (pre-sim) Ert workflow running `PRE_SIMULATION`.

To make this, first create the workflow file in

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Love the look of all this red 🔴

This branch has not been deployed

No deployments
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.

Use the new HOOK_WORKFLOW_JOB in documentation

2 participants