Skip to content

About

Data Converter for SPM Domain (STM, STS and AFM)

Topics

Resources

Stars

0 stars

Watchers

5 watching

Forks

Repository files navigation

Ruff DOI

pynxtools-spm: A pynxtools reader for SPM data

.

This pynxtools plugin was generated with cookiecutter using the pynxtools-plugin-template template.

Supported file formats

Technique Vendor Instrument software (flavor) Tested version Extension
STS Nanonis Nanonis SPM control software Generic 5, Generic 5e .dat
STM Nanonis Nanonis SPM control software Generic 5, Generic 5e .sxm
STM Omicron SM4 (read with gwyddionpy) not version specific .sm4
AFM Nanonis Nanonis SPM control software Generic 4 .sxm
AFM Bruker Bruker SPMLab (read with gwyddionpy) 1.00 .flt, written by the instrument as .FLT
AFM Bruker Bruker NanoScope (read with gwyddionpy) 9.x (Dimension Icon) .spm
AFM (force curve) Bruker Bruker NanoScope ASCII export 9.x (Dimension Icon) .spm.txt

See supported vendor files and formats for details, e.g. that one Bruker SPMLab FLT file holds a single channel of a single scan direction and is therefore converted into its own NeXus file, whereas one Bruker NanoScope .spm file holds every channel in both scan directions and yields a single NeXus file with several NXdata groups. The .spm.txt export is a force ramp (force-distance curve) rather than an image.

Installation

It is recommended to use python 3.12 with a dedicated virtual environment for this package. Learn how to manage python versions and virtual environments.

This package is a reader plugin for pynxtools and can be installed together with pynxtools:

uv pip install pynxtools[spm]

for the latest released version.

Docs

More information about this pynxtools plugin is available in the documentation. You will find information about getting started, how-to guides, the supported file formats, how to get involved, and much more there.

Contact person in FAIRmat for this reader

Rubel Mozumder

Note: This repository is an upgraded and renamed version of pynxtools-stm, which is now archived. In addition to the integration of new readers (e.g., AFM), all functionalities of pynxtools-stm remain available in this repository.

Contributing

Create your branch from develop and open your pull request against develop. Never open a pull request against main: it receives only release/* branches.

See the development guide.

About

Data Converter for SPM Domain (STM, STS and AFM)

Topics

Resources

Stars

0 stars

Watchers

5 watching

Forks

Releases

Packages

Used by

Contributors

Languages