Skip to content

[Tools] nbexecute

mmcky edited this page Feb 13, 2020 · 1 revision

nbexecute

nbexecute is a command line tool to manage the execution for collections of Jupyter notebooks (IPYNB). This will assist our project through the management of input notebooks to obtain needed results from execution of embedded code. The aim would be to make use of nbclient to execute the notebook - while providing additional features such as error reporting, caching, and parallel execution.

Features (Stage I)

  1. notebook level caching to reduce unnecessary execution
  2. generation of execution statistics (run time, kernel information, exit status)
  3. generation of readable error reports for each notebook
  4. parallel execution
  5. support for specified notebook dependencies
  6. support for external file dependencies

Features (Stage II)

  1. the ability to link back to source document to fix issues (providing contextual error information)
  2. explore cell level caching for long running notebooks

Notes & Ideas

  1. Setup a hidden .nbcache folder for use by tool for storing caching results and outputs from cells for each notebook.