rhkpy

RHK STM data analysis tool

Based on the spym project (version 0.9), for use in our research group.

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

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

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.