coupling: add to whatsnew section

lumicks · Jan 18, 2024 · 8799615 · 8799615
1 parent 0fa49d0
commit 8799615
Show file tree

Hide file tree

Showing 5 changed files with 23 additions and 0 deletions.
diff --git a/docs/theory/force_calibration/active.rst b/docs/theory/force_calibration/active.rst
@@ -92,6 +92,8 @@ We can also include a distance to the surface like before. This results in an ex
 coefficient :math:`\gamma` that depends on the distance to the surface which is given by the same
 equations as listed in the section on the :doc:`hydrodynamically correct model<hyco>`.
 
+.. _bead_bead_theory:
+
 Bead-bead coupling
 ------------------
 

diff --git a/docs/tutorial/force_calibration.rst b/docs/tutorial/force_calibration.rst
@@ -394,6 +394,8 @@ However, if we do not provide the height above the surface, we can see that the
     Consequently, when this model is selected, this parameter affects both passive and active calibration.
     For more information on this see the :doc:`theory section on force calibration</theory/force_calibration/force_calibration>` section.
 
+.. _bead_bead_tutorial:
+
 Active calibration with two beads far away from the surface
 -----------------------------------------------------------
 

diff --git a/docs/whatsnew/1.4.0/1_4_0.rst b/docs/whatsnew/1.4.0/1_4_0.rst
@@ -0,0 +1,15 @@
+Pylake 1.4.0
+============
+
+.. only:: html
+
+Pylake `v1.4.0` has been released with new features and improvements to existing analyses. Here’s some of the highlights:
+
+Bead-bead coupling correction
+-----------------------------
+
+.. figure:: correction_factor_whatsnew.png
+
+When performing active calibration with two beads coupling effects can bias the estimated calibration parameters (force and displacement sensitivity, and the stiffness).
+In Pylake 1.4.0, we include a model to account for bead-bead coupling between two beads in bulk.
+See :ref:`theory<bead_bead_theory>` and :ref:`tutorial<bead_bead_tutorial>` for more information.
diff --git a/docs/whatsnew/1.4.0/correction_factor_whatsnew.png b/docs/whatsnew/1.4.0/correction_factor_whatsnew.png
diff --git a/docs/whatsnew/index.rst b/docs/whatsnew/index.rst
@@ -8,6 +8,7 @@ For a full list of new features and changes, please refer to the :doc:`changelog
     :caption: Contents
     :maxdepth: 1
 
+    1.4.0/1_4_0
     1.3.0/1_3_0
     1.2.0/1_2_0
     1.1.0/1_1_0