energy-machines-jupyter-reports 1.0.0

A JupyterLab extension developed by Energy Machines for use with reports from THMI.

energy_machines_jupyter_reports

A JupyterLab extension.

Requirements

• JupyterLab >= 3.0

Install

pip install energy_machines_jupyter_reports

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 energy_machines_jupyter_reports directory
# Install package in development mode
pip install -e .

# Rebuild extension Typescript source after making changes
jlpm run 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.

# Watch the source directory in one terminal, automatically rebuilding when needed
jlpm run watch
# Then 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).

Uninstall

pip uninstall energy_machines_jupyter_reports