nanosurf 1.8.6

Python API for Nanosurf controllers and Nanosurf style application framework

Nanosurf Python library and application package

The Nanosurf Python package contains classes and functions for the following topics:

• Remote control of Nanosurf Studio and classic Nanosurf Atomic force microscopes
• The package contains a large number of general functions for data analysis
• Powerful QUI Framework to create nice graphical application based on QT
• Multiple demo applications

Prerequisites

• Python 3.9, 3.10 or 3.11 installed on Windows OS.
• Python 3.12 is not yet supported due to the used lupa package.
• Nanosurf Studio or any classic Nanosurf controller software with 'Scripting Interface' option activated
• MaxOS and Linux can use the library for off-line analysis

Installation and upgrading

To install the package, open a Windows Command Prompt and run:

pip install nanosurf

To upgrade your nanosurf package to the newest version, open Windows Command Prompt and run:

pip install nanosurf -U

Running the examples

We suggest to use Visual Studio Code as your IDE to run, write and debug your Python code. Install the python extension for Visual Studio Code.

In the library, Nanosurf provides a documentation, some script demos and full fledged application templates to give you a quick start. They are in the nanosurf package sub folders "app" and "doc". But where are they on your system? Depending on the exact installation of python, the package folders can be at very different places.

Therefore, the nanosurf package provides a command shell script to help you: Open Windows Command Prompt and type:

nanosurf_help

If this shell script does not run you can do it manually. Open Windows Command Prompt and type:

python 
>>> import nanosurf
>>> nanosurf.help()

The output of this command print the exact path to the app and doc folder. Use one of path to open the example scripts in Visual Studio Code (or any other python IDE) and run them.

AFM Software Programmers Manual

The classic Nanosurf AFM Control Software has a own programmers manual and can be found in the Scripting Manual in Nanosurf controller software under Help tab: Help -> Manuals -> Script Programmers Manual, or here.

Unfortunately the Nanosurf Studio application do net yet have its onw programmers manual. But we are working hard to provide this soon.

Library Version History

• v1.8.6

  • Bugfix: Class AccessoryInterface did not work after update for Studio i2c support
  • Add option 'log_amp' to plot.plot_bode()

• v1.8.5

  • Bugfix: Reloading of new Studio wrapper classes in first run did not work
  • Bugfix: sci_math.compress_spectrum() keep channel name intact
  • Add option 'log_y' to plot.plot_spectrum()

• v1.8.4

  • Bugfix: add missing lupa files for pyinstaller
  • New: add I2C-Devices: MCP45XX, MAX1161x and MMA8451

• v1.8.3

  • Bugfix: data scaling for channels without calibration factors

• v1.8.2

  • New intro page for PyPi

• v1.8.1

  • fix python version requirement check

• v1.8.0

  • prevent installation with python 3.12 due to incompatible lupa package
  • add I2C class support for Studio
  • nanosurf.app/demo_wave_mode_nma_analysis: added Hertz model

• v1.7.2

  • New: nanosurf.app/demo_wave_mode_nma_analysis: more options for file dialog

• v1.7.1

  • Bugfix: Image Points/lines where swapped on gwy_export

• v1.7.0

  • New: nanosurf.app/demo_wave_mode_nma_analysis: script which calculates max_force, adhesion and stiffness
  • New: nanosurf.lib.util.nhf_reader: Studio measurement files (*.nhf) reader
  • New: nanosurf.lib.util.nid_reader: Classic measurement files (*.nid) reader
  • New: nanosurf.lib.util.gwy_export: Gwyddion data file creator/exporter
  • New: nanosurf.app/py_installer_template: makes creating *.exe from python apps simple

• v1.6.2

  • New: qt_app_framwork supports multi screen modules
  • Bugfix: settings should not be of dataclass type

• v1.6.1

  • Bugfix: pip packaging did not copy framework files

• v1.6.0

  • New: spm_template: A new template to demonstrate simple connection to CX/Studio and measure some data
  • New: app_DriveAFM_Tip_Current_Addon this app controls the amplifier of the Tip-Current Addon
  • New: demo_move_sample_stage. This demo shows basic stage movements
  • New: demo_lateral_force_signal_calibration. This demo shows how to calibrate the lateral force signal
  • New: nanosurf.plot. A package to easily plot data array from lists, numpy array, SciChannel and SciStream
  • New: nanosurf.spm.lowlevel.DataSamplerAccess. A class to make data sampling easier for CX/Studio
  • New: nanosurf.frameworks.qt_app: A framework to easily create nice Qt applications
  • Update: all applications are using the new qt_app framework of the library
  • Update: app_frequency_sweep: add logarithmic plotting capability
  • Bugfix: app_frequency_sweep: excitation mode was inverted

• v1.5.1

  • Bugfix: Do not convert Lua arrays with string-keys
  • Bugfix: Improved Python enum conversion to Lua

• v1.5.0

  • Library supports now python v3.11
  • Library supports now PySide2 and PySide6

• v1.4.1

  • bugfix: Studio vector attributes are defined as .vector instead of .value
  • improve installation instruction for editable mode

• v1.4.0

  • Add enum support for Nanosurf Studio scripting interface
  • Nanosurf Studio properties and LogicalUnits attributes have common interface style
  • Add revers ramp feature to App_Switching_Spectroscopy
  • Some small improvements to other applications

• v1.3.4

  • fix bug in frequency_sweep

• v1.3.3

  • Improve visual appearance of some nsf.gui elements
  • fix eeprom memory write access for i2c.chip_24LC34A
  • better return value for fileutil.create_unique_folder() in case of error

• v1.3.2

  • Bugfix: Studio - handling of boolean properties was not working
  • Add support for DriveAFM Camera i2c-chip

• v1.3.1

  • Bugfix: App_switching_spectroscopy - selection of output and amplitude setting had some issues

• v1.3.0

  • Add simplifies library usage is possible. Just write 'import nanosurf as nsf' and full access to sub-libraries is provided in visual studio code
  • new app: app_switching_spectroscopy provides the possibility to measure in "Switching Spectroscopy"-Mode
  • new qui elements: nsf.gui.NSFEdit and nsf.gui.NSFComboBox
  • Bugfix: Wrong number type in Python for double based property
  • Bugfix: nsf.spm.workflow.frequency_sweep: PositionX/Y/Z was not working as output

• v1.2.0

  • Add Studio scripting support

• v1.1.0

  • Add direct I2C motor control

• v1.0.0

  • Initial release

License

MIT License