-
Notifications
You must be signed in to change notification settings - Fork 6
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: document surface calibration #697
base: main
Are you sure you want to change the base?
Conversation
3aba52b
to
f72e4db
Compare
de9a9fd
to
52a6f32
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi Joep, this is super nice, this will be very useful.
I have to read this a couple of times to understand the details. But as a very general initial feedback I would say to splits this notebook in 2:
- First just list the steps that a user has to take to start using the activate calibration, in exactly the right order. So, somebody who downloads the notebook just can load his/her own data and quickly go through the steps. (And, link to the page on the pylake docs that explains how to recalibrate the force using the obtained stiffness)
- The second part of the docs can explain the background and the mechanisms that are taken into account, and how active and passive calibration are compared.
plt.plot(heights, [calibrations[h]["pc_z"].stiffness for h in keys], 'C2--') | ||
plt.xlabel('Height [um]') | ||
plt.ylabel('Stiffness [pN/nm]'); | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Here it would be helpful to add labels 'active calibration' and 'passive calibration' and a legend
Ah yes, 1 is part of the force calibration docs reshuffle. I spun this off from that branch, since the size of it was getting out of hand. This PR really only addresses point 2 for one more advanced use case (surface calibration). edit: after discussing, it may be a good idea to move this entire notebook to the fundamentals section, as it contains a lot of detail that a typical use case probably doesn't require |
52a6f32
to
1f125a5
Compare
1f125a5
to
17e9aae
Compare
17e9aae
to
f45165a
Compare
0604ae2
to
43bf2bd
Compare
43bf2bd
to
cbc3f20
Compare
cbc3f20
to
d2339a7
Compare
Why this (work in progress) PR?
Currently, users cannot reproduce the full surface calibration workflow.
This worked example will allow them to do so, and hopefully see the advantage active calibration brings in that situation.
Docs build here.
A few open questions I still have with this:
100
nm here.0.91
for a water objective, which seems low? I would expect this closer to unity.