jupyterrunner Directory Reference

Directories
	jupyterrunner
	stellarium_jupyter_runner
	utils
	widgets

Files
	wscript

Detailed Description

The GUI provides an interface to HLCC-Stellarium interaction.

Jira: ETCS-1284

Intoduction

This module provides two GUIs:

• hlccStellariumGui
• hlccJupyterRunnerGui

hlccStellariumGui

The hlccStellariumGui provides graphical interface

• to configure the Stellarium,
• to preset the telescope to the object selected via Stellarium, and
• to command the telescope to follow the selected object.

The IP address of the host where Stellarium is running can be set at the top of the GUI. This is (currently) defaulted to local host.

The GUI is divided into three main sections, each section allows to run and stop/abort the corresponding action via buttons. When the action is started, the underlying mechanism executes the corresponding hlcc jupyterrunner via papermill tool. The output of this tool is displayed in the white output area.

For the output display one can select detailed view, by checking the corresponding checkbox. In this case all the output of the notebook is displayed, otherwise the progress of the notebook is displayed in percentage. (This is a feature of papermill)

The status of the execution of the notebook is displayed above the control buttons.

• Blue color represent a running notebook,
• green color represent a successfully completed notebook,
• red color indicates failed or aborted notebook Failure is detected by the return code of papermill. For the cause of the failure check the error messages on the output, where the lines containing text: 'error', 'failure' or 'exception' are highlighted.

The follow action is a continues loop, it runs until the user stops it or failed. During following action it is allowed to select another object via stellarium and preset to the object. The telescope will automatically follow the new object. (feature of hlcc/telif)

Any running action is stopped/aborted when the user quites the GUI.

hlccJupyterRunnerGui

The hlccJupyterRunnerGui is a more generic tool, at its current state it allows the user to run any of the hlcc jupyter notebooks.

When Stellarium notebookes are selected the IP address of the Stellarium host can be set.

The other notebooks are run with their default settings only.

This GUI allows to run only one notebook at a time, but you can start up more instances.

Prerequisites

Cii services are running

cii-services start all

Stellarium is running

Stellarium is set according HLLCC UM and running. On dev platform use the following option when starting it up:

stellarium --low-graphics

HLCC/Tel is running

On dev platform start HLCC/Telescope Simulation via GUI:

hlcctelsimui

Navigate to tab SeqTool tab (Top right section) , end execute the sequences:

• DevStartup
• Night Time mode

Start HLCC Stellarium GUI from commandline

hlccStellariumGui

or for the generic tool:

hlccJupyterRunnerGui --stellarium

Start HLCC Stellarium GUI from hlcctelsimui menu

The tool hlccStellariumGui can be also started up from the menu of hlcctelsimui. Launch/Stellarium Interface

Generetad files

The papermill tool generates notebooks with the actual parameters used, these files are stored with the name original notebook extended width timestamp under the directory: /tmp/jupyter_notebooks/

E.g. Output Notebook: /tmp/jupyter_notebooks/StellariumConfig_20250630_083310.ipynb

Notes

Jupyter Note book

cd <directory_notebooks>
jupyter notebook

check http://localhost:8888/

papermill on command line

papermill input.ipynb output.ipynb -p param1 value1 -p param2 value2
papermill /home_local/eltdev/INTROOT/jupyter_notebooks/StellariumConfig.ipynb /tmp/jupyter_notebooks/StellariumConfig_20250616_151810.ipynb -p ip 127.0.0.1

python notebook libraries

import nbformat 
import nbclient

nomad startup of telescope

nomad job run /elt/hlcc/share/nomad/hlcc.nomad.hcl

menu of hlcctelsimui

The Launch menu item is configured via (ETCS-1255): hlcc/software/telsimui/resource/config/hlcctelsimui/tools.json

improvement options for hlccJupyterRunnerGui

• help menu, configure menu for directory
• parameter display:
  • type check for parameter (in, float, str, expression )
  • option to set back to default
  • memory for parameters and status when Notebook is selected again
• logger widget at the bottom (Add GUI logs, e.g. papermill command called)
• configure parameters according to site e.g. ip