From f604424fa999d3d1559d1293a66620af46cd82a9 Mon Sep 17 00:00:00 2001 From: Mohammad Alisafaee Date: Thu, 26 Jan 2023 16:51:05 +0100 Subject: [PATCH] chore: add workflow file template (#157) Co-authored-by: Laura Kinkead --- R-minimal/workflows/my-workflow.yaml | 38 +++++++++++++++++++++++ bioc-minimal/workflows/my-workflow.yaml | 38 +++++++++++++++++++++++ julia-minimal/workflows/my-workflow.yaml | 38 +++++++++++++++++++++++ minimal/workflows/my-workflow.yaml | 38 +++++++++++++++++++++++ python-minimal/workflows/my-workflow.yaml | 38 +++++++++++++++++++++++ 5 files changed, 190 insertions(+) create mode 100644 R-minimal/workflows/my-workflow.yaml create mode 100644 bioc-minimal/workflows/my-workflow.yaml create mode 100644 julia-minimal/workflows/my-workflow.yaml create mode 100644 minimal/workflows/my-workflow.yaml create mode 100644 python-minimal/workflows/my-workflow.yaml diff --git a/R-minimal/workflows/my-workflow.yaml b/R-minimal/workflows/my-workflow.yaml new file mode 100644 index 0000000..1e89851 --- /dev/null +++ b/R-minimal/workflows/my-workflow.yaml @@ -0,0 +1,38 @@ +# === Welcome to the template Renku Workflow file! === +# You can use this file to encode in what order your data processing steps should be run, +# making it easier for you to run your workflow, and for others to understand it! + +# === How to use this template === +# Replace the script and data paths in the template below to match your analysis commands. +# Then, run `renku run my-workflow.yaml` in a terminal to execute the workflow! +# If you are working in a notebook, run `! renku run my-workflow.yaml` in a notebook cell. + +# === Docs === +# To learn much more about what you can do with the Renku Workflow File, see our docs: +# https://renku.readthedocs.io/en/stable/topic-guides/workflows/workflow-file.html + +name: my-workflow +steps: + step-one: + command: python $n $my-script $input-data $output-data + inputs: + - my-script: + path: src/script.py + - input-data: + path: data/input/sample_data.csv + outputs: + - output-data: + path: data/output/results.csv + parameters: + - n: + prefix: -n + value: 10 + + # === Adding more steps === + # You can add as many steps as you want to your workflow by copy and pasting the step template above + # TIP: To run just one step from a workflow, simply add the step name to the command, like this: + # `renku run my-workflow.yaml make-plot` + # make-plot: + # command: python $another-script $output-data $my-plot + # ... + diff --git a/bioc-minimal/workflows/my-workflow.yaml b/bioc-minimal/workflows/my-workflow.yaml new file mode 100644 index 0000000..1e89851 --- /dev/null +++ b/bioc-minimal/workflows/my-workflow.yaml @@ -0,0 +1,38 @@ +# === Welcome to the template Renku Workflow file! === +# You can use this file to encode in what order your data processing steps should be run, +# making it easier for you to run your workflow, and for others to understand it! + +# === How to use this template === +# Replace the script and data paths in the template below to match your analysis commands. +# Then, run `renku run my-workflow.yaml` in a terminal to execute the workflow! +# If you are working in a notebook, run `! renku run my-workflow.yaml` in a notebook cell. + +# === Docs === +# To learn much more about what you can do with the Renku Workflow File, see our docs: +# https://renku.readthedocs.io/en/stable/topic-guides/workflows/workflow-file.html + +name: my-workflow +steps: + step-one: + command: python $n $my-script $input-data $output-data + inputs: + - my-script: + path: src/script.py + - input-data: + path: data/input/sample_data.csv + outputs: + - output-data: + path: data/output/results.csv + parameters: + - n: + prefix: -n + value: 10 + + # === Adding more steps === + # You can add as many steps as you want to your workflow by copy and pasting the step template above + # TIP: To run just one step from a workflow, simply add the step name to the command, like this: + # `renku run my-workflow.yaml make-plot` + # make-plot: + # command: python $another-script $output-data $my-plot + # ... + diff --git a/julia-minimal/workflows/my-workflow.yaml b/julia-minimal/workflows/my-workflow.yaml new file mode 100644 index 0000000..1e89851 --- /dev/null +++ b/julia-minimal/workflows/my-workflow.yaml @@ -0,0 +1,38 @@ +# === Welcome to the template Renku Workflow file! === +# You can use this file to encode in what order your data processing steps should be run, +# making it easier for you to run your workflow, and for others to understand it! + +# === How to use this template === +# Replace the script and data paths in the template below to match your analysis commands. +# Then, run `renku run my-workflow.yaml` in a terminal to execute the workflow! +# If you are working in a notebook, run `! renku run my-workflow.yaml` in a notebook cell. + +# === Docs === +# To learn much more about what you can do with the Renku Workflow File, see our docs: +# https://renku.readthedocs.io/en/stable/topic-guides/workflows/workflow-file.html + +name: my-workflow +steps: + step-one: + command: python $n $my-script $input-data $output-data + inputs: + - my-script: + path: src/script.py + - input-data: + path: data/input/sample_data.csv + outputs: + - output-data: + path: data/output/results.csv + parameters: + - n: + prefix: -n + value: 10 + + # === Adding more steps === + # You can add as many steps as you want to your workflow by copy and pasting the step template above + # TIP: To run just one step from a workflow, simply add the step name to the command, like this: + # `renku run my-workflow.yaml make-plot` + # make-plot: + # command: python $another-script $output-data $my-plot + # ... + diff --git a/minimal/workflows/my-workflow.yaml b/minimal/workflows/my-workflow.yaml new file mode 100644 index 0000000..1e89851 --- /dev/null +++ b/minimal/workflows/my-workflow.yaml @@ -0,0 +1,38 @@ +# === Welcome to the template Renku Workflow file! === +# You can use this file to encode in what order your data processing steps should be run, +# making it easier for you to run your workflow, and for others to understand it! + +# === How to use this template === +# Replace the script and data paths in the template below to match your analysis commands. +# Then, run `renku run my-workflow.yaml` in a terminal to execute the workflow! +# If you are working in a notebook, run `! renku run my-workflow.yaml` in a notebook cell. + +# === Docs === +# To learn much more about what you can do with the Renku Workflow File, see our docs: +# https://renku.readthedocs.io/en/stable/topic-guides/workflows/workflow-file.html + +name: my-workflow +steps: + step-one: + command: python $n $my-script $input-data $output-data + inputs: + - my-script: + path: src/script.py + - input-data: + path: data/input/sample_data.csv + outputs: + - output-data: + path: data/output/results.csv + parameters: + - n: + prefix: -n + value: 10 + + # === Adding more steps === + # You can add as many steps as you want to your workflow by copy and pasting the step template above + # TIP: To run just one step from a workflow, simply add the step name to the command, like this: + # `renku run my-workflow.yaml make-plot` + # make-plot: + # command: python $another-script $output-data $my-plot + # ... + diff --git a/python-minimal/workflows/my-workflow.yaml b/python-minimal/workflows/my-workflow.yaml new file mode 100644 index 0000000..1e89851 --- /dev/null +++ b/python-minimal/workflows/my-workflow.yaml @@ -0,0 +1,38 @@ +# === Welcome to the template Renku Workflow file! === +# You can use this file to encode in what order your data processing steps should be run, +# making it easier for you to run your workflow, and for others to understand it! + +# === How to use this template === +# Replace the script and data paths in the template below to match your analysis commands. +# Then, run `renku run my-workflow.yaml` in a terminal to execute the workflow! +# If you are working in a notebook, run `! renku run my-workflow.yaml` in a notebook cell. + +# === Docs === +# To learn much more about what you can do with the Renku Workflow File, see our docs: +# https://renku.readthedocs.io/en/stable/topic-guides/workflows/workflow-file.html + +name: my-workflow +steps: + step-one: + command: python $n $my-script $input-data $output-data + inputs: + - my-script: + path: src/script.py + - input-data: + path: data/input/sample_data.csv + outputs: + - output-data: + path: data/output/results.csv + parameters: + - n: + prefix: -n + value: 10 + + # === Adding more steps === + # You can add as many steps as you want to your workflow by copy and pasting the step template above + # TIP: To run just one step from a workflow, simply add the step name to the command, like this: + # `renku run my-workflow.yaml make-plot` + # make-plot: + # command: python $another-script $output-data $my-plot + # ... +