Skip to content

Releases: ignition-kernel/ignition-project

Jupyter Kernel Exchange Resource

Pre-release

Choose a tag to compare

@null-directory null-directory released this 19 Sep 01:48
e7d5b80

Jupyter Kernel Ignition Exchange resource

2023-09-18 13_33_47-Untitled48 i… (2) - JupyterLab

Develop and run scripts for Ignition in the Jupyter Lab/Notebook environment!

Think of it as a script console that you can easily iterate on by using the notebook environment.

  • Write code in cells and execute them like it's a script console
  • Inspect objects in both gateway and designer contexts
  • Test code directly from a gateway context
  • Document code in-line using a literate markdown outlining
  • Connects using user authentication
  • Encrypted ZeroMQ sockets between Jupyter and Ignition
  • metatools :)
  • Load another project's scripts in scope, on demand
  • Theme color choice!

Requires your own install of Jupyter Lab as well as the Python package ignition-jupyter-kernel package.

Quick start:

  • Upload the Jupyter kernel project file into Ignition with the jupyter name
  • Install Jupyter
  • Install the ignition_kernel from PyPI
  • Add a kernel connection for your localhost gateway (enter login credentials - these are stored in your operating system's keyring): python -m ignition_kernel --install
  • Start Jupyter Lab
  • Select your gateway from the kernels, wait for the busy icon to clear, and start programming!

NOTE: This project will automatically download the JeroMQ (jeromq-0.5.3.jar) and the JNaCl (jnacl-1.0.0.jar) from Maven if not found in the expected location at shared.tools.jupyter.zmq.JAR_FOLDER (Ignition's pylib folder, by default).