Use nbqa and ruff to check style of notebooks

Add nbqa to the `environment.yml` file. Add a Makefile to the repo to
easily run regular tasks like building the website, running the
notebooks, checking style and autoformatting the notebooks. Add
a `check.yml` GitHub Action to check style of notebooks in PRs.

Author: santisoler

.github/workflows/check.yml

@@ -0,0 +1,32 @@
+name: Check style
+
+on:
+  # Check style after every push to main
+  push:
+    branches:
+      - main
+  # Check style on every PR
+  pull_request:
+
+jobs:
+
+  style:
+    runs-on: ubuntu-latest
+    env:
+      ENVIRONMENT_FILE: environment.yml
+      ENVIRONMENT_NAME: simpeg-user-tutorials
+
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v4
+
+      - name: Setup Miniforge
+        uses: conda-incubator/setup-miniconda@v3
+        with:
+          miniforge-version: Miniforge3
+          environment-file: $ENVIRONMENT_FILE
+          activate-environment: $ENVIRONMENT_NAME
+
+      - name: Check style of notebooks
+        bash:
+          make check

Makefile

@@ -0,0 +1,29 @@
+NOTEBOOKS_DIR=notebooks
+
+.PHONY: build run clean check format
+
+help:
+	@echo "Commands:"
+	@echo ""
+	@echo "  build   build Myst website (without running notebooks)"
+	@echo "  clean   clean output of Myst website"
+	@echo "  run     run all notebooks"
+	@echo "  check   lint notebooks with nbqa and ruff"
+	@echo "  format  autoformat notebooks with nbqa and ruff"
+	@echo ""
+
+
+build:
+	msyt build --html
+
+clean:
+	msyt clean --all
+
+run:
+	jupyter nbconvert --to notebook --execute --inplace "${NOTEBOOKS_DIR}/**/*.ipynb"
+
+check:
+	nbqa ruff "${NOTEBOOKS_DIR}/**/*.ipynb"
+
+format:
+	nbqa ruff --fix "${NOTEBOOKS_DIR}/**/*.ipynb"

environment.yml

@@ -12,3 +12,6 @@ dependencies:
   - simpeg==0.22.*
   - discretize==0.10.*
   - pymatsolver
+  # Code quality
+  - nbqa
+  - ruff