jupyter: set up ruff to work with notebooks

Author: lucaspar

jupyter/compose/local/jupyter/jupyterhub_config.py

@@ -93,16 +93,20 @@ def get_env(self):
 # It represents the directory from which docker-compose is run
 host_pwd = os.environ.get("HOST_PWD")
 if not host_pwd:
-    raise ValueError(
+    msg = (
         "HOST_PWD environment variable not set. "
         "Make sure you're using docker-compose which passes PWD as HOST_PWD."
     )
+    raise ValueError(msg)
 sample_scripts_host_path = Path(host_pwd) / "compose/local/jupyter/sample_scripts"
 print(f"Sample scripts host path: {sample_scripts_host_path}")
 
 c.DockerSpawner.volumes = {
     "jupyterhub-user-{username}": {"bind": c.DockerSpawner.notebook_dir, "mode": "rw"},
-    sample_scripts_host_path: {"bind": "/home/jovyan/work/sample_scripts", "mode": "ro"},
+    sample_scripts_host_path: {
+        "bind": "/home/jovyan/work/sample_scripts",
+        "mode": "ro",
+    },
 }
 
 # === AUTHENTICATION AND ACCCESS CONTROL ===

jupyter/compose/local/jupyter/sample_scripts/spectrogram.ipynb

@@ -10,7 +10,7 @@
     "from spectrumx.client import Client\n",
     "\n",
     "# Create an SDK client to download DigitalRF data from the SDS\n",
-    "# \n",
+    "#\n",
     "# Recommended: Store your token in a .env file (e.g., \"secrets.env\") with:\n",
     "#   SDS_SECRET_TOKEN=your_token_here\n",
     "#\n",
@@ -37,13 +37,14 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from digital_rf import DigitalRFReader\n",
     "import h5py\n",
     "import numpy as np\n",
-    "import matplotlib.pyplot as plt\n",
-    "from scipy.signal.windows import gaussian\n",
+    "from digital_rf import DigitalRFReader\n",
+    "from drf_plot import (\n",
+    "    specgram_plot,  # make sure drf_plot.py is in the same folder as this code\n",
+    ")\n",
     "from scipy.signal import ShortTimeFFT\n",
-    "from drf_plot import specgram_plot # make sure drf_plot.py is in the same folder as this code\n",
+    "from scipy.signal.windows import gaussian\n",
     "\n",
     "# set the data directory where the DigitalRF data is stored (top level)\n",
     "data_dir = \"data/files/YOUR_USERNAME/YOUR_PATH/\"  # TODO: change to your local data path\n",
@@ -56,15 +57,19 @@
     "    start_sample, end_sample = reader.get_bounds(channel)\n",
     "\n",
     "    with h5py.File(f\"{data_dir}/{channel}/drf_properties.h5\", \"r\") as f:\n",
-    "        sample_rate = f.attrs[\"sample_rate_numerator\"] / f.attrs[\"sample_rate_denominator\"]\n",
+    "        sample_rate = (\n",
+    "            f.attrs[\"sample_rate_numerator\"] / f.attrs[\"sample_rate_denominator\"]\n",
+    "        )\n",
     "\n",
     "    num_samples = int(sample_rate * 2)\n",
     "    rf_data = reader.read_vector(start_sample, num_samples, channel)\n",
     "\n",
     "    # Compute spectrogram\n",
     "    window = gaussian(1000, std=100, sym=True)\n",
     "    fft_size = 1024\n",
-    "    stfft = ShortTimeFFT(window, hop=500, fs=sample_rate, mfft=fft_size, fft_mode=\"centered\")\n",
+    "    stfft = ShortTimeFFT(\n",
+    "        window, hop=500, fs=sample_rate, mfft=fft_size, fft_mode=\"centered\"\n",
+    "    )\n",
     "    spectrogram = stfft.spectrogram(rf_data)\n",
     "\n",
     "    # Convert to dB\n",
@@ -77,7 +82,6 @@
     "    zscale = (zscale_low, zscale_high)\n",
     "    print(f\"zscale low: {zscale_low}\")\n",
     "    print(f\"zscale high: {zscale_high}\")\n",
-    "    \n",
     "\n",
     "    # Create extent for plotting\n",
     "    extent = stfft.extent(num_samples)\n",
@@ -87,7 +91,7 @@
     "        extent=extent,\n",
     "        log_scale=True,\n",
     "        zscale=zscale,\n",
-    "        title=f\"Spectrogram - {channel}\"\n",
+    "        title=f\"Spectrogram - {channel}\",\n",
     "    )"
    ]
   },