Skip to content

Plugins

There are a number of plugins available for pynxtools that are maintained within FAIRmat. These are extensions of pynxtools used for reading data of specific experimental techniques.

Photoemission spectroscopy

  • pynxtools-mpes: A reader for multi-dimensional photoelectron spectroscopy (MPES) data.
  • pynxtools-xps: A reader for X-ray photoelectron spectroscopy (XPS) data from various vendors. Documentation can be found here.

Electron microscopy

  • pynxtools-em: A reader for electron microscopy data from various vendors. Documentation can be found here.

Atom probe tomography

  • pynxtools-apm: A reader for atom probe as well as related field ion microscopy data. Documentation can be found here.

Optical spectroscopy

Scanning probe microscopy

  • pynxtools-stm: A reader for scanning tunneling microscopy (SPM) and spectroscopy (STS) data.

X-ray diffraction

Others

Installation

You can install each of the plugins together with pynxtools by passing the name of the plugin as an extra to the pip install call. For example, for the pynxtools-mpes plugin:

pip install pynxtools[mpes]

In addition, you can also install all of the pynxtools reader plugins which are maintained by FAIRmat by passing the [convert] extra to the pip install call:

pip install pynxtools[convert]