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.
1 maintainer
Metadata
1 maintainer
Release files for pynxtools-spm 0.4.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| pynxtools_spm-0.4.1.tar.gz | 1.7 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| pynxtools_spm-0.4.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 3.4 MB
Release files / pynxtools_spm-0.4.1.tar.gz
| Download URL | pynxtools_spm-0.4.1.tar.gz |
|---|---|
| Size | 1.7 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
246517b1dc6857bece83a76eea2d0ec34f0489fa1e54ceac30d8ac78994da57c
|
|
BLAKE2b-256 checksum How to use checksums |
e76ec0807f516413505861f3bb86e4522c4eb4b642a45a031525d672f04b4817
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 5, 2026.
Transparency logRelease files / pynxtools_spm-0.4.1-py3-none-any.whl
| Download URL | pynxtools_spm-0.4.1-py3-none-any.whl |
|---|---|
| Size | 1.7 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
593556f4bb30c0f3440c1f0230150aa6dd1646c2e15055edb289d574418e4b29
|
|
BLAKE2b-256 checksum How to use checksums |
67dd7a9ffea4d9c051fbee5443a07010859e1fba5ce804ebc18ae90acec6e80e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 5, 2026.
Transparency log
