Skip to main content

Mulfile is a Python library for reading .mul and .flm files, acquired by the scanning tunneling microscopy (STM) software “SpecsProbe.exe”, which is used with the SPM 150 Aarhus by SPECS.

Installing

Installation via pip:

$ pip install mulfile

Example Usage

import mulfile as mul


# load a mul or flm file
stm_images = mul.load('path/to/mulfile.mul')

This returns all STM-images and their metadata as a list-like object. Thus, it is possible to access images by indexing and slicing.

# get the first STM-image
image_1 = stm_images[0]

# get images 1 to 5
images = stm_images[0:5]

Single STM-images are stored in objects with their image data (2D numpy array) and metadata as attributes.

# get the image data for image_1
image_1.img_data

# get the bias voltage for image_1
image_1.bias

It is also possible to save one or multiple images in the native file format of gwyddion (.gwy)

# save the complete mul-file as a gwyddion file
stm_images.save_gwy('output.gwy')

Status

STM-images, together with the corresponding metadata, are fully supported in both .mul and .flm files. Pointscans are not supported yet.

Metadata

Release files for mulfile 0.4.0

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

Source distribution (sdist)

Source distribution for mulfile 0.4.0
File Size Uploaded
mulfile-0.4.0.tar.gz 6.4 kB Details

Built distribution (wheel)

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

Total release size: 13.8 kB

Release files / mulfile-0.4.0.tar.gz

Download URL mulfile-0.4.0.tar.gz
Size 6.4 kB
Tags Source
SHA-256 checksum
How to use checksums
56a57c9be8c1aa15354f65df16ec5a4d1e7e01834942e496c978a685647a61f7
BLAKE2b-256 checksum
How to use checksums
43b0e98d2421277a4da56af3cbea4dd4576a951c0601420b229a44625ef1a724
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.8.3 CPython/3.12.5 Darwin/23.6.0

Release files / mulfile-0.4.0-py3-none-any.whl

Download URL mulfile-0.4.0-py3-none-any.whl
Size 7.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
052913fc74f2ca28280a9b02166e5de90cbf4ba4c9630d76213b0826fd8b59cd
BLAKE2b-256 checksum
How to use checksums
516772ec43e5c112b0cc0b7b78c78c64675d2d37291682687c742f4afb4d2149
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.8.3 CPython/3.12.5 Darwin/23.6.0

Release history Release notifications | RSS feed

This release

0.4.0 This release

2 release files

0.3.0

2 release files

0.2.0

2 release files

0.1.0

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