pynxtools-apm 0.2.4

Make atom probe tomography and field-ion microscopy results interoperable via NeXus

Parse and normalize atom probe tomography and field-ion microscopy data

Installation

It is recommended to use python 3.12 with a dedicated virtual environment for this package. Learn how to manage python versions and virtual environments.

This package is a reader plugin for pynxtools and thus should be installed together with pynxtools:

pip install pynxtools[apm]

for the latest release version from pypi.

If you are interested in the newest version, we recommend to work with a development installation instead.

Purpose

This reader plugin for pynxtools is used to translate diverse file formats from the scientific community and technology partners within the field of atom probe tomography and field-ion microscopy into a standardized representation using the NeXus application definition NXapm.

Supported file formats

This plugin supports the majority of the file formats that are currently used for atom probe. A detailed summary is available in the reference section of the documentation.

Getting started

A getting started tutorial is offered that guides you on how to use the apm reader for converting your data to NeXus using a Jupyter notebook or command line calls. Note that not every combination of input from a supported file format and other input, such as from an electronic lab notebook, allows filling the required and recommended fields and their attributes of the NXapm application definition. Therefore, you may need to provide an ELN file that contains the missing values in order for the validation step of the APM reader to pass.

Contributing

We are continously working on improving the collection of parsers and their functionalities. If you would like to implement a parser for your data, feel free to get in contact.

Development install

Install the package with its dependencies:

git clone https://github.com/FAIRmat-NFDI/pynxtools-apm.git --branch main --recursive pynxtools_apm
cd pynxtools_apm
python -m pip install --upgrade pip
python -m pip install -e ".[dev,docs]"
pre-commit install

The last line installs a pre-commit hook which automatically formats (linting) and type checks the code before committing.

Test this software

Especially relevant for developers, there exists a basic test framework written in pytest which can be used as follows:

python -m pytest -sv tests

Contact person in FAIRmat for this reader

Markus Kühbach