Make atom probe tomography and field-ion microscopy results interoperable via NeXus
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.
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.
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.
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.
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.
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.
Especially relevant for developers, there exists a basic test framework written in pytest which can be used as follows:
python -m pytest -sv tests
FAQs
Make atom probe tomography and field-ion microscopy results interoperable via NeXus
We found that pynxtools-apm demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.