Using SMA with Jupyter Notebooks

Can I use Python notebook (.ipynb files) in the tool?

Yes! The notebook file will need to be in the source directory that you choose as input for the tool. They can be anywhere in the directory and you do not need to limit your run of the tool to those notebooks. You can have any python code with a .py extension and any notebook code with a .ipynb extension in your source code directory (or any subfolders in that directory).

Is there any reason to convert my notebook files to .py files?

That depends. If you want to continue to use the notebooks as notebooks, then there is no need to extract the python into .py files. If you are looking to move away from notebooks, then there is a workaround to extract the python code from the notebook. Recall though that the tool can process either, so for SMA to execute an analysis or conversion, the notebooks can stay as they are.

If you want to expose only the Python code in the notebook files, you can use the nbconvert utility. Follow these steps:

1. Install the nbconvert utility. For Python, you can do a pip install for this utility by running pip install nbconvert. NOTE: If you are using MacOS, you will probably will need to run pip3 install nbconvert or python3 -m pip install nbconvert.

2. Create a copy of the directory that has the notebook source code

3. Convert all of the notebook scripts by running this command from the command line: find /path/to/folder/with/notebooks -name '*.ipynb' | xargs python -m nbconvert --to script Note: If you are using MacOS you probably need to run find /path/to/folder/with/notebooks -name '*.ipynb' | xargs python3 -m nbconvert --to script instead. This command will recursively convert the notebooks to python scripts. The output will be dropped into the given directory.

4. Run SMA for Python on the output directory. This will process the *.py files found in the directory.