Key Performance Indicators

A book to track our KPIs.

To build the book locally

Use the nox tool like so:

nox -s docs

This will install the necessary requirements and build the book locally.

To build the book with a live server to detect changes, run:

nox -s docs -- live

To run a JupyterLab environment with packages installed

Run this command:

nox -s lab

Using Jupytext

The Jupyter Notebooks in this repository are stored as MyST Markdown notebooks. This means they're text files instead of .ipynb files. See the jupytext documentation for more details.

If there is an error

If there's an error in executing any of the cells above, you can browse the logs via the GitHub Action that is automatically run.

To do so:

• Go to the action page
• Click on the Summary tab, and then at the bottom download the .zip
• Scroll down to Artifacts
• Click the zip file for sphinx-logs
• The results of computation are in sphinx-logs.zip\dirhtml\reports