- Install an environment that contains
nbscuid
, e.g. with the instructions here - Activate this environment (e.g.
conda activate nbscuid-dev
) - Clone this repo, which must be done recursively in order to clone the associated submodules:
git clone --recurse-submodules https://github.com/rmshkv/nbscuid-adf-sandbox.git
-
Navigate to the top-level folder,
nbscuid-adf-sandbox
-
Run
nbscuid-run config.yml
NOTE: You can actually run this command from anywhere, just change
config.yml
to the full path relative to your location. -
Run
nbscuid-build config.yml
NOTE: The built Jupyter Book files will appear in
computed_notebooks/adf-quick-run/_build
, try openingindex.html
!
Check out the config.yml
file. This page has some instructions for how to add new notebooks and their parameters, and this is an example of a config.yml file that uses some more options, including adding scripts.