A reader for transferring EM from vendor formats to NeXus and NOMAD.

Navigation

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for mkuehbach from gravatar.com mkuehbach

Unverified details

These details have not been verified by PyPI
Meta
  • License: Apache Software License (Apache License)
  • Author: The NOMAD Authors
  • Requires: Python >=3.10
  • Provides-Extra: dev , docs , ipynb
Classifiers
Report project as malware

Project description

Ruff DOI

Parse and normalize electron 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[em]

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 electron microscopy into a standardized representation using the NeXus application definition NXem.

Supported file formats

This plugin supports several file formats that are currently used within the research field of electron microscopy. 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 em reader for converting your data to NeXus from 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 all required and recommended fields including their attributes of the NXem application definition. Therefore, you may need to provide an ELN file that contains the missing values in order for the validation step of the EM reader to pass.

Contributing

We are continuously 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-em.git --branch main --recursive pynxtools_em
cd pynxtools_em
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

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for mkuehbach from gravatar.com mkuehbach

Unverified details

These details have not been verified by PyPI
Meta
  • License: Apache Software License (Apache License)
  • Author: The NOMAD Authors
  • Requires: Python >=3.10
  • Provides-Extra: dev , docs , ipynb
Classifiers

Release history Release notifications | RSS feed

This version

0.4.2

0.4.1

0.4.0

0.3.3

0.3.2

0.3.1

0.3.0

0.2

0.1.1

0.1

Download files

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

Source Distribution

pynxtools_em-0.4.2.tar.gz (133.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pynxtools_em-0.4.2-py3-none-any.whl (225.1 kB view details)

Uploaded Python 3

File details

Details for the file pynxtools_em-0.4.2.tar.gz.

File metadata

  • Download URL: pynxtools_em-0.4.2.tar.gz
  • Upload date:
  • Size: 133.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for pynxtools_em-0.4.2.tar.gz
Algorithm Hash digest
SHA256 f29b4f0cbbb74da74bff5d71547756023b31607398e9e24b6ce097f04c74b1f9
MD5 cdeb49c2bac25e9b3f21cb7f760d49c7
BLAKE2b-256 64717bb926e5128af0c8ec42666e9f5f362b7144911c89993512abe6a361b253

See more details on using hashes here.

Provenance

The following attestation bundles were made for pynxtools_em-0.4.2.tar.gz:

Publisher: publish.yml on FAIRmat-NFDI/pynxtools-em

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pynxtools_em-0.4.2-py3-none-any.whl.

File metadata

  • Download URL: pynxtools_em-0.4.2-py3-none-any.whl
  • Upload date:
  • Size: 225.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for pynxtools_em-0.4.2-py3-none-any.whl
Algorithm Hash digest
SHA256 0f54456fe0527b88f1ddab03ddb0571da8e0e6e0f28c0d1959a66cb78399a2ea
MD5 e7f03fef901c19e4340f0cc9c58dd199
BLAKE2b-256 758623c7cf641bfcf4b05ac6bb8cadfcfa42ddb862797b0691dc537c7e18fddf

See more details on using hashes here.

Provenance

The following attestation bundles were made for pynxtools_em-0.4.2-py3-none-any.whl:

Publisher: publish.yml on FAIRmat-NFDI/pynxtools-em

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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