Quality assurance

Python dependencies¶

Ensure that the Python dependencies required to run the notebook(s) are included in the environment.yml file.

Coding standards¶

Ensure that all code in the notebook(s) adheres to the ECMWF coding standards for Python.

To do so, activate your jupyter-build (see here for how to install it) environment:

conda activate jupyter-build

Then, install the flake8-nb package and run the code standards tests on your notebook (replace $NOTEBOOK with the path to your notebook file):

# install necessary packages
conda install flake8-nb
 
# execute tests with CDS configuration options:
flake8_nb --max-line-length 100 --max-doc-length 100 $NOTEBOOK