From a19db0b0ac8ad387ff647e82808e20fcc924d772 Mon Sep 17 00:00:00 2001
From: Eric Kooistra <kooistra@astron.nl>
Date: Tue, 24 Oct 2023 08:59:19 +0200
Subject: [PATCH] Use of jupyter-notebook.

---
 .../lofar2/model/readme_lofar2_model.txt      | 22 +++++++++++++++----
 doc/erko_howto_tools.txt                      |  4 ++++
 2 files changed, 22 insertions(+), 4 deletions(-)

diff --git a/applications/lofar2/model/readme_lofar2_model.txt b/applications/lofar2/model/readme_lofar2_model.txt
index 64336e1a03..225f03e057 100644
--- a/applications/lofar2/model/readme_lofar2_model.txt
+++ b/applications/lofar2/model/readme_lofar2_model.txt
@@ -5,7 +5,8 @@ Contents:
 1) Original LOFAR1 scripts from FilterTaskForce.zip [1]
 2) Original LOFAR1 documents
 3) Copied from APERTIF [3]
-4) LOFAR2.0
+4) LOFAR2.0 PFB in VHDL
+5) LOFAR2.0 Python notebooks for quantization and statistics
 
 
 References:
@@ -27,7 +28,7 @@ References:
      coefficients is not available anymore (For Apertif Erko looked in old
      repositories back to 2005 of Lofar software and Station firmware
      but could not find it.)
-                                                                      
+
 - pfs_coeff_final.m [1]
      creates Coefficient_16KKaiser.dat, but using e.g. meld shows that
      these do differ slightly within +-40 from
@@ -58,7 +59,20 @@ APERTIF uses the same PFB FIR coefficients as LOFAR1.
                                      time and frequency domain, and optionally calls pfir_coeff_dc_adjust.m
 
 
+4) LOFAR2.0 PFB in VHDL
+
+- tb_tb_verify_pfb_wg.vhd, 2021 [4] : VHDL simulation of LOFAR1 PFB2 (pfb2_unit.vhd) and APERTIF WPFB
+                                      (wpfb_unit_dev.vhd) for LOFAR2.0
+
+
+5) LOFAR2.0 Python notebooks for quantization and statistics
+
+- lofar2_station_sdp_firmware_model.ipynb: SDP FW quantization levels
+- signal_statistics.ipynb: SNR improvement for beamformer, correlator and powers
 
-4) LOFAR2.0
+The notebook results are used in [1]. Start Jupyter notebook kernel with:
+> jupyter-notebook &
+and then navigate to the notebook script in the browser and open it.
+The results of the ipynb runs are stored as html files with the same name.
 
-- tb_tb_verify_pfb_wg.vhd, 2021 [4] : VHDL simulation of LOFAR1 PFB2 and APERTIF WPFB for LOFAR2.0
+[1] "L4 SDPFW Decision: LOFAR2.0 SDP Firmware Quantization Model", https://support.astron.nl/confluence/pages/viewpage.action?spaceKey=L2M&title=L4+SDPFW+Decision%3A+LOFAR2.0+SDP+Firmware+Quantization+Model
diff --git a/doc/erko_howto_tools.txt b/doc/erko_howto_tools.txt
index a6da5816e2..e7717922eb 100755
--- a/doc/erko_howto_tools.txt
+++ b/doc/erko_howto_tools.txt
@@ -1472,6 +1472,10 @@ https://www.dataquest.io/blog/advanced-jupyter-notebooks-tutorial/
 
 uses Markdown
 
+Start Jupyter notebook kernel for LOFAR2 quantization and statistics models with:
+> jupyter-notebook &
+and then navigate to the notebook script in the browser and open it.
+
 Startup with:
 > jupyter-lab  # lab is new,
 
-- 
GitLab