Skip to content

Commit

Permalink
chore: add workflow file template (#157)
Browse files Browse the repository at this point in the history
Co-authored-by: Laura Kinkead <[email protected]>
  • Loading branch information
m-alisafaee and lokijuhy authored Jan 26, 2023
1 parent f2a7781 commit f604424
Show file tree
Hide file tree
Showing 5 changed files with 190 additions and 0 deletions.
38 changes: 38 additions & 0 deletions R-minimal/workflows/my-workflow.yaml
Original file line number Diff line number Diff line change
@@ -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
# ...

38 changes: 38 additions & 0 deletions bioc-minimal/workflows/my-workflow.yaml
Original file line number Diff line number Diff line change
@@ -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
# ...

38 changes: 38 additions & 0 deletions julia-minimal/workflows/my-workflow.yaml
Original file line number Diff line number Diff line change
@@ -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
# ...

38 changes: 38 additions & 0 deletions minimal/workflows/my-workflow.yaml
Original file line number Diff line number Diff line change
@@ -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
# ...

38 changes: 38 additions & 0 deletions python-minimal/workflows/my-workflow.yaml
Original file line number Diff line number Diff line change
@@ -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
# ...

0 comments on commit f604424

Please sign in to comment.