Skip to main content

Read a Nanonis spectroscopy .dat file into a xarray Dataset

Project description

Read Nanonis spectroscopy .dat files into xarray Datasets

pypi conda-forge pypi downloads license python SPEC 0 — Minimum Supported Dependencies ci pre-commit.ci status codecov ruff

nanonis_xarray is a Python module to read spectroscopy measurements saved in text format (.dat) by a Nanonis Mimea SPM control system from SPECS Surface Nano Analysis GmbH.

The data is read into a xarray.Dataset, where each measured quantity, such as tunnelling current or AFM oscillation amplitude, is a xarray.DataArray with up to three dimensions:

  • The independent variable of the measurement, such as bias voltage or tip z position;
  • The sweep number, if the measurement has been repeated multiple times;
  • The sweep direction (forward or backward), if the independent variable has been swept in both directions.

It becomes then easy to e.g. plot the average of one measured channel in the forward direction:

from matplotlib import pyplot as plt
import xarray as xr

data = xr.opne_dataset("tests/data/z.dat")
fig, ax = plt.subplots()
data["current"].mean(dim=["sweep"]).sel(direction="fw").plot()

🚧 Work in progress 🚧

This library is under development: expect breaking changes. Nanonis binary formats (.sxm, .3ds) are currently not supported, and can be read by similar projects:

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

nanonis_xarray-0.1.3.tar.gz (9.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

nanonis_xarray-0.1.3-py3-none-any.whl (8.8 kB view details)

Uploaded Python 3

File details

Details for the file nanonis_xarray-0.1.3.tar.gz.

File metadata

  • Download URL: nanonis_xarray-0.1.3.tar.gz
  • Upload date:
  • Size: 9.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for nanonis_xarray-0.1.3.tar.gz
Algorithm Hash digest
SHA256 966ebd81ca5abfb1c5cdb468d96df8fe37f8831f59ccce8a4a3b16ca65e7bc98
MD5 7366b0439bfbc675232413d9f9ff326f
BLAKE2b-256 558bd67a47b357eff7cdb65f8563068e27abf0b4de16a5e4fd0b3a0ad56239d0

See more details on using hashes here.

Provenance

The following attestation bundles were made for nanonis_xarray-0.1.3.tar.gz:

Publisher: ci.yaml on angelo-peronio/nanonis-xarray

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file nanonis_xarray-0.1.3-py3-none-any.whl.

File metadata

  • Download URL: nanonis_xarray-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 8.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for nanonis_xarray-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 5d0bbecb83f8ffc8f1ccfd161e17ec4ad4c0cf5dd03e04e95e47de724424d65a
MD5 19c1c6c5928e1345f4f233259e82b7fe
BLAKE2b-256 ac57b258b8b46f7ccbf55e3bb617b09104e93981d046c90cc5784b7364d1f1b2

See more details on using hashes here.

Provenance

The following attestation bundles were made for nanonis_xarray-0.1.3-py3-none-any.whl:

Publisher: ci.yaml on angelo-peronio/nanonis-xarray

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page