unfolder: Save the timestamp, x-position, and temp under environment/
[unfold-protein.git] / README
1 Unfolding experiment procedure:
2
3 At the ipython command line (use -pylab option for easy plotting)
4 >>> import unfold
5 >>> u = unfold.unfold(controlTemp=False)
6
7 Approach the surface
8 >>> u.stepApproach(setpoint=1.0)
9 Hold down during approach to keep O-ring from lifting the
10 head. Diagnose by watching under video-microscope: head movement
11 shifts picture.  Alternatively, use the flexible S-crossectioned
12 "o-rings" or scrunchies to clamp head on tighter ;).
13
14 Wiggle for interference just off the surface
15 >>> u.stepAway(); u.stepAway(); u.stepAway()
16 >>> import z_piezo_utils
17 >>> z_piezo_utils.wiggleForInterferenceMin(u.zp, wig_freq=1.0)
18
19 Calibrate
20 >>> import calibcant.calibrate
21 >>> calibcant.config.DEFAULT_TEMP = 25 # degrees C
22 >>> calibcant.calibrate.calib(stepper=u.step, zpiezo=u.zp, push_depth=90)
23 push_depth is in nm.  There are a host of other keyword arguments to
24 calib.  See them all with
25 >>> calibcant.calibrate.calib._kwargs(calibcant.calibrate.calib)
26
27 Tweak coarse surface position (these are stepper-backlash protected functions)
28 >>> u.stepCloser()
29 >>> u.stepAway()
30
31 Unfold a protein
32 >>> u.unfold(rel_setpoint=2, nmDist=1400,...)
33
34 There's also a convenience function `loop_rates`
35 >>> rates = [250, 500, 750, 1000]
36 >>> unfold.loop_rates(u, rates=rates, num_loops=10, die_file="~/die",
37                       rel_setpoint=1, nmDist=800, sBindTime=2, ...)
38 which unfolds at each rate 10 times, unless ~/die exist, in which case
39 it stops nicely.  rel_setpoint, nmDist, sBindTime, and other additional
40 options are just passed on to unfold.unfold().
41
42 Modules :
43 see unfold.png
44
45
46 Remember,
47 >>> help(whatever)
48 is your friend in Python, and
49 $ man whatever
50 and
51 $ whatever --help
52 are your friends in a shell.