Skip to content
This repository has been archived by the owner on Dec 11, 2023. It is now read-only.

Adds Jupyter Notebook driver #104

Closed
wants to merge 21 commits into from
Closed

Conversation

ChrisKeefe
Copy link
Collaborator

@ChrisKeefe ChrisKeefe commented Mar 12, 2023

Like it says on the tin, this enables provenance replay to produce Jupyter Notebook (.ipynb) files.

Notes

  • Exposes a new usage_driver='jn' choice for provenance replay at the CLI and Python API
  • A Jupyter Notebook is generated (in addition to the CLI and Python3 scripts) within reproducibility supplement zip archives
  • Jupyter-notebook specific helptext is included in the notebook's "header" cell
  • Within the generated notebook, each QIIME 2 Action and any new immediate dependencies (e.g. Metadata.load() and get_column() calls) are enclosed in the same notebook cell.
  • use.comment() is no longer used internally to generate inline comments, as this will break JN cell semantics

Draft status

This code has been extensively playtested (and the CLI and Python drivers have been unit tested and diffed against regressions), but no unit tests have been written for the new driver at this time.

Review comments and playtesting feedback are welcome.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant