Skip to main content

A python package for processing Scanning Tunneling Microscopy (STM) data from RHK, based on the spym project.

Project description

RHK STM data analysis tool

Based on the spym project (version 0.9.1).

Documentation can be found here: https://zrbyte.github.io/rhkpy/

Binder

If you use this package in your publication, consider citing it: Peter Nemes-I., & Mirco Panighel. (2023). zrbyte/rhkpy: v1.3.3 (v1.3.3). Zenodo. https://zenodo.org/doi/10.5281/zenodo.10143224 DOI

Main features

  • Able to handle spectroscopy measurements (both dI/dV and I(z)):
    • dI/dV maps
    • spectra along a line
    • individual spectra
  • Resample dI/dV maps along a line (see mapsection)
  • Quick, interactive visualization of spectroscopy data (see qplot)
  • Recreating the "navigation" window in Rev9, by plotting the relative positions of measurements (see the navigation function).
  • Generating thumbnails of your measurements (see genthumbs)
  • Peak fitting (see peakfit)

Installation

pip install rhkpy

Simple example

import rhkpy

# Load an sm4 file
data = rhkpy.rhkdata('filename.sm4')

# "quick plot" of the data
data.qplot()

# make thumbnails of the sm4 files in the current working directory
rhkpy.genthumbs()

Also take a look at the demo.ipynb and tutorial.ipynb Jupyter notebooks in this repository.

To make the most of rhkpy, also consult the xarray documentation and check out plotting examples, with HoloViews. The HoloViews website has examples on how to customize plots, as well as tutorial notebooks.

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

rhkpy-1.3.9.tar.gz (42.0 kB view details)

Uploaded Source

Built Distribution

rhkpy-1.3.9-py3-none-any.whl (45.6 kB view details)

Uploaded Python 3

File details

Details for the file rhkpy-1.3.9.tar.gz.

File metadata

  • Download URL: rhkpy-1.3.9.tar.gz
  • Upload date:
  • Size: 42.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.10.14

File hashes

Hashes for rhkpy-1.3.9.tar.gz
Algorithm Hash digest
SHA256 91914d5a7c0943fd24942be343d89704d6d215c7c8ec5d1e3c35708bb0bfe891
MD5 111b4c0d637d23795e10e1cfcc0258e1
BLAKE2b-256 77fffd4a3ec0c94f23534f7c968400c4210afbca1fb3f0b95b9d1653fe2f7f65

See more details on using hashes here.

File details

Details for the file rhkpy-1.3.9-py3-none-any.whl.

File metadata

  • Download URL: rhkpy-1.3.9-py3-none-any.whl
  • Upload date:
  • Size: 45.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.10.14

File hashes

Hashes for rhkpy-1.3.9-py3-none-any.whl
Algorithm Hash digest
SHA256 055f35d4d186a361256c6aa33c81375e88e781716b742f804aa2bffb073ae933
MD5 fcb89cb797fef71b943373ce80e9c5b2
BLAKE2b-256 d31afa51338fd61d67e7b13d6cdee04c921970cac010e2f06e0f648dbeb1d992

See more details on using hashes here.

Supported by

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