Skip to main content

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.

Metadata

Release files for rhkpy 1.3.10

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for rhkpy 1.3.10
File Size Uploaded
rhkpy-1.3.10.tar.gz 43.1 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for rhkpy 1.3.10
File Interpreter ABI Platform
rhkpy-1.3.10-py3-none-any.whl Python 3 none any Details

Total release size: 89.7 kB

Release files / rhkpy-1.3.10.tar.gz

Download URL rhkpy-1.3.10.tar.gz
Size 43.1 kB
Tags Source
SHA-256 checksum
How to use checksums
02601b63503bc816dcadbf03f871bc1745984bb46ca72c6cac9535fb021b1228
BLAKE2b-256 checksum
How to use checksums
15be571ea30049e25a91f8d5aa5a6a19fe8ff6f9ada12a22a4015013fe1f6e5c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.10.20

Release files / rhkpy-1.3.10-py3-none-any.whl

Download URL rhkpy-1.3.10-py3-none-any.whl
Size 46.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
3b7a4a56ba27ce6bcc38f065b38b4267f7adf405209689330fcb44297961af9e
BLAKE2b-256 checksum
How to use checksums
24a858875d00dc95f33c8886ae17b1986be2b1ac901c74df72c18d1718580f7a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.10.20

Release history Release notifications | RSS feed

This release

1.3.10 This release

2 release files

1.3.9

2 release files

1.3.8

2 release files

1.3.7

2 release files

1.3.6

2 release files

1.3.5

2 release files

1.3.4

2 release files

1.3.3

2 release files

1.3.2

2 release files

1.3.1

2 release files

1.3.0

2 release files

1.2.1

2 release files

1.2.0

2 release files

1.1.0

2 release files

1.0.2

2 release files

1.0.1

2 release files

1.0.0

2 release files

0.1.4

2 release files

0.1.3

2 release files

0.1.2

2 release files

0.1.1

2 release files

0.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page