From 0bec197ec086aead6174b0a6c8a303b1955d79d6 Mon Sep 17 00:00:00 2001 From: Joep Vanlier Date: Thu, 18 Jan 2024 18:09:19 +0100 Subject: [PATCH] coupling: add to `whatsnew` section --- docs/theory/force_calibration/active.rst | 2 ++ docs/tutorial/force_calibration.rst | 2 ++ docs/whatsnew/1.4.0/1_4_0.rst | 15 +++++++++++++++ .../whatsnew/1.4.0/correction_factor_whatsnew.png | 3 +++ docs/whatsnew/index.rst | 1 + 5 files changed, 23 insertions(+) create mode 100644 docs/whatsnew/1.4.0/1_4_0.rst create mode 100644 docs/whatsnew/1.4.0/correction_factor_whatsnew.png diff --git a/docs/theory/force_calibration/active.rst b/docs/theory/force_calibration/active.rst index 91defd0a3..d9b96e076 100644 --- 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`. +.. _bead_bead_theory: + Bead-bead coupling ------------------ diff --git a/docs/tutorial/force_calibration.rst b/docs/tutorial/force_calibration.rst index dc230d65b..a12c08435 100644 --- 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` 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 new file mode 100644 index 000000000..95a6f208e --- /dev/null +++ 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` and :ref:`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 new file mode 100644 index 000000000..c6f679bb5 --- /dev/null +++ b/docs/whatsnew/1.4.0/correction_factor_whatsnew.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2d6dd1f6d3d42ef44ef8d0b3e5b894d5b7000ee78ae5fe90fa065477ca84b287 +size 129678 diff --git a/docs/whatsnew/index.rst b/docs/whatsnew/index.rst index 778287685..b5b29e0c8 100644 --- 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