gsffile 0.5.4

Read and write Gwyddion Simple Field files

Read and write Gwyddion Simple Field files

gsffile is a Python module to:

• read image and metadata from Gwyddion Simple Field (.gsf) files, and
• store NumPy arrays in Gwyddion Simple Field files.

It features type annotations, minimal logging, and an overgrown test suite.

Setup

Install with pip

python -m pip install gsffile

or with conda

conda install gsffile

Quickstart

>>> from gsffile import read_gsf, write_gsf
>>> import numpy as np

# The Gwyddion Simple Field format supports only 32-bit floating point data.
>>> data = np.eye(100, dtype=np.float32)

# Optional metadata.
>>> metadata = {
...    "XReal": 5e-05,
...    "YReal": 5e-05,
...    "XYUnits": "m",
...    "ZUnits": "V",
...    "CustomKey": 33,
...    }

>>> write_gsf("example.gsf", data, metadata)

>>> data, metadata = read_gsf("example.gsf")

Documentation

gsffile is documented via docstrings:

python -c "import gsffile; help(gsffile)"

How to cite

Cite gsffile in your published work using the version-specific metadata in CITATION.cff, or this general BibTeX entry:

@misc{Dri_gsffile_2024,
title = {gsffile},
author = {Dri, Carlo and Peronio, Angelo},
url = {https://github.com/angelo-peronio/gsffile},
doi = {10.5281/zenodo.16998022},
year = {2024},
month = {7}
}

Specific DOIs for each released version are listed on Zenodo, but are not included in CITATION.cff due to a limitation of Zenodo itself.