From 9bd02393688a4c1d79d6299de2ecb152b17e6bff Mon Sep 17 00:00:00 2001 From: Roy Willy Haug <5484176+roywilly@users.noreply.github.com> Date: Thu, 23 Mar 2023 10:39:16 +0100 Subject: [PATCH] Update fmu-docs (#157) --- src/fmu/sumo/uploader/scripts/sumo_upload.py | 23 ++++++++++---------- 1 file changed, 11 insertions(+), 12 deletions(-) diff --git a/src/fmu/sumo/uploader/scripts/sumo_upload.py b/src/fmu/sumo/uploader/scripts/sumo_upload.py index d348a815..08edaef8 100644 --- a/src/fmu/sumo/uploader/scripts/sumo_upload.py +++ b/src/fmu/sumo/uploader/scripts/sumo_upload.py @@ -24,25 +24,23 @@ logger.setLevel(logging.CRITICAL) # This documentation is for sumo_uploader as an ERT workflow -DESCRIPTION = """ -SUMO_UPLOAD will upload files to Sumo. The typical use case is as add-on to +DESCRIPTION = """SUMO_UPLOAD will upload files to Sumo. The typical use case is as add-on to post-processing workflows which aggregate data across an ensemble and stores the results outside the realization folders. SUMO_UPLOAD is implemented both as FORWARD_JOB and WORKFLOW_JOB and can be called from -both contexts when running ERT. -""" +both contexts when running ERT.""" -EXAMPLES = """ -In an existing workflow e.g. ``ert/bin/workflows/MY_WORKFLOW`` with the contents:: - MY_JOB - SUMO_UPLOAD /MyIteration/share/results/tables/*.csv -...where ``MY_JOB`` typically refers to a post-processing job creating data. -...and where typically refers to // +EXAMPLES = """In an existing workflow e.g. ert/bin/workflows/MY_WORKFLOW with the contents + +MY_JOB +SUMO_UPLOAD /MyIteration/share/results/tables/*.csv + +where ``MY_JOB`` typically refers to a post-processing job creating data +and where typically refers to // is typically set in the config as it is used also by forward jobs. -It must refer to a valid Sumo environment. Normally this should be set to "prod". -""" # noqa +It must refer to a valid Sumo environment. Normally this should be set to prod.""" def main() -> None: @@ -198,6 +196,7 @@ def legacy_ertscript_workflow(config): @hook_implementation +@plugin_response(plugin_name="SUMO_UPLOAD") def job_documentation(job_name): if job_name != "SUMO_UPLOAD": return None