JPSL_Tools_Menu

JLab compatible convenience menu for common activities in Jupyter Physical Science Lab.

Current menu items:

• "Hide before print" hides cells selected for hiding using jupyter-instructortools .
• "Undo hide before print" reveals the hidden cells.
• "Algebra with Sympy" submenu:
  • "Insert Algebra with Sympy initialization code" inserts in place of the current selection the properly formed import statement to initialize the Algebra_with_Sympy package.
  • "Algebra with Sympy Docs" opens a new browser window showing the documentation.
• "JupyterPiDaQ" submenu:
  • "Insert JupyterPiDAQ initialization code" inserts in place of the current selection the properly formed import statement to initialize the JupyterPiDAQ live data acquisition package.
  • "JupyterPiDAQ Docs" opens the documentation in a new browser window.
• "Pandas GUI" submenu:
  • "Insert PandasGUI initialization code" inserts in place of the current selection the properly formed import statement to initialize the PandasGUI package of graphical tools to help generate code to manipulate and display data stored in Pandas DataFrames.
  • "Insert load data from CSV code" replaces the current selection with the skeleton code for loading data from a CSV file into a Pandas DataFrame.
  • "Insert New Calculated Column GUI" replaces the current selection with a function call that opens the graphical user interface to assist in generating code to create a new calculated column in a Pandas DataFrame.
  • "Insert New Plot GUI" replaces the current selection with a function call that opens the graphical user interface to generate code for making a Plotly plot from data in a Pandas DataFrame.
  • "Insert New Fit GUI" replaces the current selection with a function call that opens the graphical user interface to generate code for fitting data using the lmfit package and plotting the results using Plotly.
  • "PandasGUI Docs" opens the documentation in a new browser window.

Requirements

• JupyterLab >= 4.0.0
• algebra_with_sympy >= 1.0.0
• jupyterpidaq >= 0.8.1
• jupyter-pandas-gui >= 0.9.0

Install

To install the extension, execute:

pip install JPSL_Tools_Menu

Uninstall

To remove the extension, execute:

pip uninstall JPSL_Tools_Menu

Contributing

Development install

Note: You will need NodeJS to build the extension package.

The jlpm command is JupyterLab's pinned version of yarn that is installed with JupyterLab. You may use yarn or npm in lieu of jlpm below.

# Clone the repo to your local environment
# Change directory to the JPSL_Tools_Menu directory
# Install package in development mode
pip install -e "."
# Link your development version of the extension with JupyterLab
jupyter labextension develop . --overwrite
# Rebuild extension Typescript source after making changes
jlpm build

You can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the extension.

#  Optional: Watch the source directory in one terminal, automatically 
#   rebuilding when needed
jlpm watch
# Run JupyterLab in another terminal
jupyter lab

With the watch command running, every saved change will immediately be built locally and available in your running JupyterLab. Refresh JupyterLab to load the change in your browser (you may need to wait several seconds for the extension to be rebuilt).

By default, the jlpm build command generates the source maps for this extension to make it easier to debug using the browser dev tools. To also generate source maps for the JupyterLab core extensions, you can run the following command:

jupyter lab build --minimize=False

Development uninstall

pip uninstall JPSL_Tools_Menu

In development mode, you will also need to remove the symlink created by jupyter labextension develop command. To find its location, you can run jupyter labextension list to figure out where the labextensions folder is located. Then you can remove the symlink named JPSL_Tools_Menu within that folder.

Testing the extension (not complete yet)

Frontend tests

This extension is using Jest for JavaScript code testing.

To execute them, execute:

jlpm
jlpm test

Integration tests

This extension uses Playwright for the integration tests (aka user level tests). More precisely, the JupyterLab helper Galata is used to handle testing the extension in JupyterLab.

More information are provided within the ui-tests README.

Packaging the extension

See RELEASE