Skip to content

Commit

Permalink
docs: add profile list info to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
MrHedmad committed Jul 12, 2024
1 parent ce45e87 commit f81edf3
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 3 deletions.
8 changes: 6 additions & 2 deletions docs/src/manual/pipe_docstrings.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,12 @@
If you execute `kerblam run` without specifying a pipe (or you try to run a
pipe that does not exist), you will get a message like this:
```
Error: no runtime specified. Available runtimes:
Error: No runtime specified. Available runtimes:
◾◾ process_csv
🐋◾ save_plots
◾◾ generate_metrics
Available profiles: No profiles defined.
```
The whale emoji (🐋) represents pipes that [have an associated Docker container](run_containers.html).

Expand All @@ -32,10 +34,12 @@ to only have a single contiguous description block in each file.

The output of `kerblam run` will now read:
```
Error: no runtime specified. Available runtimes:
Error: No runtime specified. Available runtimes:
◾📜 process_csv :: Calculate the sums of the input metrics
🐋◾ save_plots
◾◾ generate_metrics
Available profiles: No profiles defined.
```
The scroll (📜) emoji appears when Kerblam! notices a long description.
You can show the full description for such pipes with `kerblam run process_csv --desc`.
Expand Down
19 changes: 18 additions & 1 deletion docs/src/manual/run.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,24 @@ In short, `kerblam run` does something similar to this:
This is why workflows are written as if they are executed in the root of the
project, because they are.

### Listing out workflows
If you just want a list of workflows that Kerblam! can see, just use
`kerblam run` with no workflow specified. Kerblam will reply with something
like this:

```
Error: No runtime specified. Available runtimes:
◾📜 process_csv :: Calculate the sums of the input metrics
🐋◾ save_plots
◾◾ generate_metrics
Available profiles: No profiles defined.
```

Workflows with a 📜 have [an associated description](pipe_docstrings.md), and
those with a 🐋 have [an associated docker container](run_containers.md).
You also get a list of available data profiles, which are detailed just below.

## Data Profiles - Running the same workflows on different data

You can run your same workflows, *as-is*, on different data thanks to data profiles.
Expand Down Expand Up @@ -160,4 +178,3 @@ For example, you can tell `make` to build a different target with this syntax:
kerblam run make_workflow -- other_target
```
As if you had run `make other_target` yourself.

4 changes: 4 additions & 0 deletions docs/src/manual/run_containers.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,8 @@ are prepended with a little whale (🐋):
Error: No runtime specified. Available runtimes:
🐋◾ my_workflow :: Generate the output data in a docker container
◾◾ local_workflow :: Run some code locally
Available profiles: No profiles defined.
```

### Default dockerfile
Expand All @@ -68,6 +70,8 @@ pipes that use the default container, so you can identify them easily:
Error: No runtime specified. Available runtimes:
🐋◾ my_workflow :: Generate the output data in a docker container
🐟◾ another :: Run in the default container
Available profiles: No profiles defined.
```

### Switching backends
Expand Down

0 comments on commit f81edf3

Please sign in to comment.