Add a script to validate jupiter notebooks

[abhiram6121]

Description

Add Jupyter notebooks to CI #726

Checklist:

• I have added tests to cover my changes.
• I have updated the documentation accordingly.
• I have read the CONTRIBUTING document.

[copy-pr-bot]

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

[github-actions]

CLA Assistant Lite bot All Contributors have signed the CLA.

[abhiram6121]

I have read the Contributor License Agreement and I hereby accept the Terms.

[bmhowe23]

/ok to test

Command Bot: Processing...

[github-actions]

CUDA Quantum Docs Bot: A preview of the documentation can be found here.

[bmhowe23]

Thanks, @abhiram6121. Please take a look at https://github.com/NVIDIA/cuda-quantum/actions/runs/6721623115?pr=848 to see a couple of things that our CI is pointing out ... namely the missing license preamble and Python formatting. The license preamble can be copied from other Python files, and that prior link provides a diff that can be used to patch your changes (simply formatting updates).

Also, take a look at https://github.com/NVIDIA/cuda-quantum/actions/runs/6722600981/job/18271591978?pr=848. It looks like the new script reported the following:

Traceback (most recent call last):
  File "/home/cudaq/notebook_validation.py", line 4, in <module>
    import nbformat
ModuleNotFoundError: No module named 'nbformat'

[abhiram6121]

Also, take a look at https://github.com/NVIDIA/cuda-quantum/actions/runs/6722600981/job/18271591978?pr=848. It looks like the new script reported the following:

Traceback (most recent call last):
  File "/home/cudaq/notebook_validation.py", line 4, in <module>
    import nbformat
ModuleNotFoundError: No module named 'nbformat'

It seems nbconvert is not installed in the github runner. How do i install it?

[bettinaheim]

Also, take a look at https://github.com/NVIDIA/cuda-quantum/actions/runs/6722600981/job/18271591978?pr=848. It looks like the new script reported the following:

Traceback (most recent call last):
  File "/home/cudaq/notebook_validation.py", line 4, in <module>
    import nbformat
ModuleNotFoundError: No module named 'nbformat'

It seems nbconvert is not installed in the github runner. How do i install it?

@abhiram6121 In docker_images.yml, after the line you added, you need to add another line

docker exec -e TERM=xterm cuda-quantum python3 -m pip install nbconvert nbformat

This installs nbconvert in the container environment, where the validation script runs. I see in the error above that it actually complained about nbformat, so just I added that to the install line as well.

[bmhowe23]

/ok to test

Command Bot: Processing...

[bettinaheim]

@abhiram6121 I used your script to validate the notebooks prior to release. Unfortunately, it looks like running the preprocessor doesn't actually execute the notebook code. I know the docs page of nbconvert suggest to do exactly what you did, and states that it will be executed, but that actually seems to be misleading. The docs were not particularly helpful in finding out what function the command line invokes, so I would have had to look through the code to see how the API has to be called. I instead opted to keep things simpler and went with the following script:

import glob, os, sys
import subprocess
from shutil import which
if which('jupyter') is None:
    print("Please install jupyter, e.g. with `pip install notebook`.")
    exit(1)


"""
This script runs all the notebooks in the current directory, and catches and reports any raised exceptions.
"""

def execute(notebook_filename):
    notebook_filename_out = notebook_filename.replace(
        '.ipynb', '.nbconvert.ipynb')

    success = True
    try:
        subprocess.run(["jupyter", "nbconvert", "--to", "notebook", "--execute", notebook_filename], check = True)
        os.remove(notebook_filename_out)
    except subprocess.CalledProcessError:
        print('Error executing the notebook "%s".\n\n' % notebook_filename)
        success = False
    return success


if __name__ == '__main__':
    if len(sys.argv) > 1:
        notebook_filenames = sys.argv[1:]
    else:
        # Use glob to find files with the specified extension in the current directory
        notebook_filenames = [
            fn for fn in glob.glob(f"*.ipynb") if not fn.endswith('.nbconvert.ipynb')]

    if notebook_filenames:
        notebooks_failed = []
        for notebook_filename in notebook_filenames:
            if not execute(notebook_filename):
                notebooks_failed.append(notebook_filename)

        if len(notebooks_failed) > 0:
            print("Failed! The following notebook(s) raised errors:\n" +
                  " ".join(notebooks_failed))
        else:
            print("Success! All the notebook(s) executed successfully.")
    else:
        print('Failed! No notebook found in the current directory.')

[abhiram6121]

@bettinaheim Thanks for the help, have updated accordingly. Please take a look and let me know.

[bettinaheim]

/ok to test

Command Bot: Processing...

[github-actions]

CUDA Quantum Docs Bot: A preview of the documentation can be found here.

[bettinaheim]

/ok to test

Command Bot: Processing...

[github-actions]

CUDA Quantum Docs Bot: A preview of the documentation can be found here.

[bettinaheim]

/ok to test

Command Bot: Processing...

[github-actions]

CUDA Quantum Docs Bot: A preview of the documentation can be found here.

[bettinaheim]

/ok to test

Command Bot: Processing...

[github-actions]

CUDA Quantum Docs Bot: A preview of the documentation can be found here.

[bettinaheim]

/ok to test

Command Bot: Processing...

[bettinaheim]

At long last, I've updated out images to contain the necessary tools, and everything looks good. abhiram6121 Thank you very much for this contribution!