Skip to main content

Python API for Nanosurf controllers

Project description

Python API for Nanosurf controllers

Package for data acquisition and control of Nanosurf atomic force microscopes.

Nanosurf Python

Prerequisites

  • Python installation on Windows OS.
  • A Nanosurf controller software running and a controller connected to the PC.
  • Nanosurf Scripting Interface option activated

Installation

Assuming that a Python interpreter is already installed in the system, open Windows Command Prompt, or Windows PowerShell and run:

pip install nanosurf

If for some reason pip does not work, unzip the content of the package into a folder and in this folder run:

python setup.py install

Usage Example

import nanosurf
spm = nanosurf.C3000() # or .CX(), or CoreAFM()
application = spm.application

scan = application.Scan
opmode = application.OperatingMode
approach = application.Approach
zcontrol = application.ZController
head = application.ScanHead

# Set file mask
mask = "TestSample-"
application.SetGalleryHistoryFilenameMask(mask)

# Choose cantilever
head.Cantilever = 19 # Predefined cantilever Dyn190

# Operating mode
opmode.OperatingMode = 3 # Dynamic mode
opmode.VibratingAmpl = 0.5 # V 

# Set scan parameters
scan.ImageWidth = 5e-6 # m
scan.ImageHeight = 5e-6 # m
scan.Scantime = 0.55 # s
scan.Points = 256 # points per line
scan.Lines = 256 # lines
scan.CenterPosX = 10e-6 # m
scan.CenterPosY = 10e-6 # m
scan.SlopeX = 0.0 # degree
scan.SlopeY = 0.0 # degree
scan.Overscan = 5 #%

# Set Z controller parameters
zcontrol.SetPoint = 70 #%
zcontrol.PGain = 3100
zcontrol.IGain = 3500

# Start scan
scan.Start()

# Check if scanning
scanning = scan.IsScanning
print(scanning)

# Stop scan
scan.Stop()

# Get image
scan.StartCapture()

Scripting Manual

Full list of objects and methods can be found in the Scripting Manual in Nanosurf controller software under Help tab: Help -> Manuals -> Script Programmers Manual, or here.

License

MIT License

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nanosurf-0.3.10.1-3.tar.gz (55.1 kB view hashes)

Uploaded source

Built Distribution

nanosurf-0.3.10.1.post3-py3-none-any.whl (61.6 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page