Skip to content

Commit

Permalink
Merge branch 'master' of github.com:krassowski/nbpipeline
Browse files Browse the repository at this point in the history
  • Loading branch information
krassowski committed Mar 30, 2020
2 parents ce4a8b9 + a91e998 commit 5a6cd5b
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,8 +58,13 @@ NotebookRule(
```

the keys of the input and output variables should correspond to variables in one of the first cells
in the corresponding notebook, which should be tagged as "parameters".
You will be warned if your notebook has no cell tagged as "parameters".
in the corresponding notebook, which should be tagged as "parameters". It can be done easily in JupyterLab:

<img src="https://raw.githubusercontent.com/krassowski/nbpipeline/master/examples/screenshots/tags_in_JupyterLab_2.0.png" width=550>

If you forget to add them, a warning will be displayed.

Alternativaly, you can create a dedicated cell for input paths definitions and tag it "inputs" and a separate one for output paths definitions, tagging it "outputs", which allows to omit input and output keywords when creating a `NotebookRule`. However, only simple variable definitions will be deduced (parsing uses regular expressions to avoid potential dangers of `eval`).

For more details, please see the example [pipeline](https://github.com/krassowski/nbpipeline/blob/master/examples/pipeline.py) and [notebooks](https://github.com/krassowski/nbpipeline/tree/master/examples/analyses) in the [examples](https://github.com/krassowski/nbpipeline/tree/master/examples) directory.

Expand Down

0 comments on commit 5a6cd5b

Please sign in to comment.