Setup_Jupyter - ArrowElectronics/AnalogMAX GitHub Wiki

Jupyter Notebook is an open-source web application that supports an open source distribution of Python called Anaconda. The application is written in Python and executes within a web browser. The Pyserial library allows the application software to access the serial/USB driver used to communicate with the FTDI chip on the board. (The serial/USB driver is standard in modern Windows installations and does not require an explicit installation.)

The following web browsers are supported when run on a windows PC: Chrome and Edge. Internet Explorer is not supported. The demos may work in other operating systems and browsers, but have not been tested.

About the demos

The demo software sends commands to the module to configure the gain setting and initiate sampling. The software collects the samples and displays it to the GUI. The demos merely provide examples of how a user can evaluate the devices with little effort by using a simple communication interface. They help illustrate how the user could later further extend the demo software, write a new application using the existing protocol, or even write custom application software and embedded firmware if desired.

Starting Jupyter

To open Jupyter, press the windows key and type Jupyter, this presents "Jupyter Notebook (AnacondaX)" to you, from which one can start Jupyter.

Jupyter is based on the server client structure, the server is executed in the background, and the client is a webpage inside your default browser. Please note that if you want to run Jupyter in a different browser, then you must change the default browser in your Windows configuration settings.

So opening it starts the server, which opens a console displaying status messages of the server. The console must be open all the time, you want Jupyter to run. You can minimize it.

Opening a demo

Generally, the Jupyter tab inside your browser is in itself a file browser. Jupyter has access only to your user or home folder which it displays after the program start. To start a notebook, one has to navigate to the folder containing the notebook file.

Left clicking on a folder opens it. Going back or a level up is accomplished by clicking the back button of your browser.

The path to this demo or notebook from within Windows Explorer looks like this:

C:\Users\your_username\arrow_demos\TEI0015-0x-08-C8A_Jupyter-ADC-demo_V2.1_quartus18.1_20191023\TE0015_&_TEI0016-Jupyter-ADC-demo_V2.1\

From within the Chrome Browser the path looks like this. Pay note of the arrow_demos portion of the path to insure the files were copied to the correct path:

localhost:8888/tree/arrow_demos/TEI0015-0x-08-C8A_Jupyter-ADC-demo_V2.1_quartus18.1_20191023/TE0015_%26_TEI0016-Jupyter-ADC-demo_V2.1/

In the picture below these steps are shown.

Click on the TE0015_&_TEI0016-Jupyter-ADC-demo_V2.1.ipynb. This will start the application in another tab as shown below:

Alter the COM port to yours

Every demo communicates with the module by a serial communication port. This port has been assigned a number during the driver installation. In our case it is COM5.

If unsure which port the device is on, open the Device Manager in Windows. Disconnect and reconnect the device. The port that newly appears is the COM port being used.

In dependency to the code of a demo, there are two variants.

Variant 1:
At the beginning of the Notebook is a line:

ser = serial.Serial('COM5', 115200) or comport = 'COM5'

Replace the comport number in red with yours and save this change by pressing "s" whilst holding the control key (Ctrl + s).

Variant 2:
Some demos contain a graphical user interface. The available comport will be presented automatically and can be selected trough the GUI.
As an option, a default comport can be set at the beginning of the notebook.

A notebook consists of cells, in which its content resides. Demos so far only contain one cell, to run the demo, the PC's focus must be upon the cell, left clicking into the cells source code focuses this cell.

The demo can be run through pressing the run button,
stopped by the button with the black rectangular,
reloaded through the circular arrow and lastly
reloaded and rerun by the two arrowed button.

The notebook can be closed either by closing the tab or via File → "Close and Halt".

Often demos gather data from the module and display them in graph plots. All output of a notebooks cell is displayed below the cell.

Next Steps