rusty-tip 0.2.2

Rust library for Nanonis SPM system control via TCP
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97

# Tip Preparation Configuration
# This config enables stability checking with bias sweep method

[nanonis]
host_ip = "127.0.0.1"
control_ports = [6501, 6502, 6503, 6504]

# Be carefull these files must exist on the host machine
# layout_file = "./examples/layout_tip-prep.lyt"
# settings_file = "./examples/settings_tip-prep.ini"

[data_acquisition]
data_port = 6590
sample_rate = 2000

[experiment_logging]
enabled = true
output_path = "./experiments"

[console]
verbosity = "info"

[tip_prep]
# Frequency shift bounds for determining if tip is sharp (in Hz)
# Values within this range indicate a sharp tip
sharp_tip_bounds = [-1.5, 0.0]

# Maximum number of pulse cycles (unlimited if not set)
max_cycles = 10000

# Maximum duration in seconds (unlimited if not set)
max_duration_secs = 12000

# Stability check configuration
[tip_prep.stability]
# Enable stability checking with bias sweep
# When true, performs a scan with bias sweep to verify tip stability
# When false, only checks if tip is sharp based on bounds
check_stability = true

# Maximum allowed change in frequency shift for tip to be considered stable (in Hz)
# During the bias sweep, if the signal changes more than this threshold,
# the tip is considered unstable and will undergo tip shaping
stable_tip_allowed_change = 0.4

# Bias voltage range for stability sweep (lower, upper) in V
# Must be positive magnitude-only; polarity_mode determines sign
bias_range = [0.2, 2.0]

# Number of steps in the bias sweep
bias_steps = 1000

# Time to wait at each step in milliseconds
step_period_ms = 200

# Maximum duration for stability check in seconds
max_duration_secs = 100

# Polarity mode for bias sweep:
# - "positive": Single sweep from 0 to upper_bound
# - "negative": Single sweep from 0 to lower_bound
# - "both": Two consecutive sweeps - first 0 to upper_bound, then 0 to lower_bound
polarity_mode = "both"

# Scan speed for stability check in m/s
# If set, the scan speed will be temporarily changed during stability check
# and restored afterward. Use a slower speed for more reliable stability detection.
# Set to null or remove this line to use the current scan speed
scan_speed_m_s = 5e-9  # 5 nm/s

[pulse_method]
# Use linear pulse method
type = "linear"

# Output pulse voltage range (in V)
# This is the Y-axis: minimum and maximum pulse voltages
voltage_bounds = [2.0, 7.0]

# Frequency shift range to monitor (in Hz)
# When freq_shift is outside this range, pulse with max voltage (voltage_bounds[1])
# When inside this range, linearly map freq_shift to pulse voltage
linear_clamp = [-20.0, 0.0]

# Polarity of the pulse voltage: "positive" or "negative"
polarity = "positive"

# When enabled, every Nth pulse will use the opposite polarity
[pulse_method.random_polarity_switch]
enabled = true
switch_every_n_pulses = 5  # Every 5th pulse uses opposite polarity

# Optional: Custom TCP channel mapping
# Uncomment and modify if your Nanonis signal indices differ from the defaults
# Format: { nanonis_index = X, tcp_channel = Y }
[[tcp_channel_mapping]]
nanonis_index = 76  # Frequency shift
tcp_channel = 19 # use 21 - demo-mode and 19 - LT