Installing Jupyter Notebook Server on Microsoft Windows 10

You can now install IBM® Cognos® Analytics for Jupyter Notebook Server for Microsoft Windows 10 either on the same computer or on a different computer from where Cognos Analytics is installed.

The Jupyter Notebook Server supports Linux and Microsoft Windows 10 platforms and requires Docker to be installed.

Note: Docker CE (Community Edition), Docker Engine, and Docker Desktop (CE) are supported at this time.

When you download and run the installer script, you load and start Docker containers. These containers allow Cognos Analytics users to create and edit Jupyter Notebook. By default, Cognos Analytics for Jupyter Server is configured with many of the most common data science/analytic Python packages.

Tip: You can later upgrade the Python packages in your existing installation.

Before you begin

Before you install Jupyter Notebook Server, follow these steps:

  1. Verify that the Hyper-V Platform is running so that Linux containers can run on a windows host.
    1. Open the Control Panel.
    2. Click Programs.
    3. Click Turn Windows Features on or off.
    4. Find and expand the Hyper-V option.
    5. Ensure that the Hyper-V Platform is checked.
  2. Install Docker as the container engine for Jupyter Notebook.

    Follow the Microsoft Windows 10 procedures at Installing Docker Desktop for Windows

    Important: The Jupyter server requires that Docker use Linux containers. If your Docker Desktop installation was configured to use Windows containers, do one of the following tasks:
    • Right-click the Docker icon in the bottom-right corner of the window and then select the option to switch to Linux containers.
    • Re-install Docker Desktop, ensuring that you do not select the option to use Windows containers instead of Linux containers.

    You must be added to the Docker group for any Docker command to run without root privileges.

  3. Set the fully qualified domain in Cognos Configuration.
    1. In IBM Cognos Configuration, in the Explorer window, click Environment.
    2. Under the Dispatcher URI for external applications set the fully qualified domain name (FQDN) for the IBM Cognos Analytics server.
    3. Under the Gateway URI set the fully qualified domain name (FQDN) for the IBM Cognos Analytics server.
    4. Click File > Save.
    5. Restart the Cognos Analytics service.

Procedure

  1. Download the IBM Cognos Analytics for Jupyter Notebook Server installer and Server repository from Passport Advantage.
    Tip: See the Cognos Analytics 11.1.5 Download Document to find out which part number to download.
  2. Double click the installer file.
  3. Follow the directions in the installation wizard to copy and install the files to your computer.
    Tip: You can install on top of an older version of Jupyter Server.
    The folder jupyter_installation_location/dist folder contains two subfolders:
    • dist/images
    • dist/scripts
      Tip: The folder dist/scripts/windows contains all the scripts and configuration files for windows installations.

      Script

      		 Purpose
      build.bat Run this to rebuild the images.
      config.conf Edit this configuration file to change Jupyter parameters.
      install.bat Run this to load and start the Docker containers.
      prune.bat Run this to remove old Docker images.
      startup.bat Run this to start the Jupyter server.
      stop.bat Run this to stop the Jupyter server.
      uninstall.bat Run this to uninstall Jupyter server.
  4. Open a command prompt window with administrator privileges.
  5. Navigate to the dist/scripts/windows directory.
  6. Type ./install.bat

    The install script runs.

Results

All of the Jupyter Server Docker images are loaded from the jupyter_installation_location/dist/images directory and the Docker containers are started.

What to do next

After installing IBM Cognos Analytics for Jupyter Notebook Server, the following tasks can be performed:

Uninstalling Jupyter Notebook Server

To uninstall Jupyter Notebook Server, open a command prompt window with administrator privileges and navigate to the dist/scripts/windows directory and then type ./uninstall.bat