Skip to main content

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

Project description

Ruff

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

Installation

It is recommended to use python 3.11 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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pynxtools_apm-0.2.1.tar.gz (248.5 kB view details)

Uploaded Source

Built Distribution

pynxtools_apm-0.2.1-py3-none-any.whl (51.2 kB view details)

Uploaded Python 3

File details

Details for the file pynxtools_apm-0.2.1.tar.gz.

File metadata

  • Download URL: pynxtools_apm-0.2.1.tar.gz
  • Upload date:
  • Size: 248.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.6

File hashes

Hashes for pynxtools_apm-0.2.1.tar.gz
Algorithm Hash digest
SHA256 f5b66b08fe05acd51c4c3547811acc2c22430ffa387ff9a9de66082555e17f39
MD5 da0c7c2573036a37b4950da16be6163a
BLAKE2b-256 7ffdf9563c12541f6c3fed947db380bb60dd6a0edc9f1ad13239e98a8cee4dff

See more details on using hashes here.

File details

Details for the file pynxtools_apm-0.2.1-py3-none-any.whl.

File metadata

File hashes

Hashes for pynxtools_apm-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 2fe8da5cd83505deaa05661621994273b8467bc5983d1266b4c40eb8fab3d9a9
MD5 9bca47444efec0d7d534bc9a16154c0f
BLAKE2b-256 c1da11b4e53d1c36c1d024f415964338697283c83db03845beb80d5a03bda79c

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page