How To Perform a Health Check of the Jupyter Environment

[helpfultoaster]

How To: Perform a Health Check of the Jupyter Environment

This article will review how to perform a health check of the Jupyter environment to aid in troubleshooting issues with the Python Tool. This will help to ensure that Jupyter Notebooks function correctly on the machine outside of Designer.

Prerequisites

•     Alteryx Designer
  •     Versions: All

Procedure to Perform Health Check

1. Locate the Scripts Folder
   1. Check your version of Designer (Help>About)
      1.  For versions 2020.4 and older, go to C:\Program Files\Alteryx\bin\Miniconda3\envs\JupyterTools_vEnv\Scripts
      2. For versions 2021.1 and newer, go to C:\Program Files\Alteryx\bin\Miniconda3\envs\DesignerBaseTools_vEnv\Scripts
2. Confirm that the Scripts folder contains the files jupyter.exe and jupyter-notebook.exe.
3. Open Command Prompt
4. Navigate to the Scripts directory
   1. For versions 2020.4 and older, run the command cd C:\Program Files\Alteryx\bin\Miniconda3\envs\JupyterTools_vEnv\Scripts
   2. For versions 2021.1 and newer, run cd C:\Program Files\Alteryx\bin\Miniconda3\envs\DesignerBaseTools_vEnv\Scripts
5. Run jupyter-notebook.exe

How to Interpret Results of a Health Check

• If, after running jupyter-notebook.exe, your default browser opens up and shows a blank jupyter notebook, then your jupyter environment is healthy and you can move on to other troubleshooting steps.
• If you are missing either jupyter.exe or jupyter-notebook.exe, then you have an unhealthy installation. Contact Support to get a copy of the missing file. Then, perform the health check again.
• If you have both files but running jupyter-notebook.exe results in errors within Command Prompt, then you are most likely missing some dependencies and have an unhealthy environment. Save the error messages you receive and contact Support.

Exceptions

There’s an exception to every rule, isn’t there? In this case, it is actually possible that this Health Check could produce errors in Command Prompt on a machine that is able to run Jupyter notebooks just fine within Designer. This doesn’t come up much because, well, if it’s working in Designer our users are typically content. However please be aware that we have seen at least one such error:

 

The error message ModuleNotFoundError: No module named ‘pysqlite2’ indicates that the machine is missing the python package pysqlite2. While this does indicate an unhealthy Jupyter environment, as Jupyter did not open correctly, this machine was able to run Jupyter within Designer just fine.

 

null

[PhaniV]

I get "Fatal error in launcher: Unable to create process using '"d:\program files\alteryx\bin\miniconda3\envs\designerbasetools_venv\python.exe" "C:\Program Files\Alteryx\bin\Miniconda3\envs\DesignerBaseTools_vEnv\Scripts\jupyter-notebook.exe" ': The system cannot find the file specified.

Any ideas to fix this?