Skip to main content

Make electron microscopy results interoperable via NeXus

Project description

Ruff

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


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.3.0.tar.gz (456.4 kB view details)

Uploaded Source

Built Distribution

pynxtools_em-0.3.0-py3-none-any.whl (206.5 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for pynxtools_em-0.3.0.tar.gz
Algorithm Hash digest
SHA256 883e314f3b62c2090126c36f9d889253cd8a54a4355ee0ac45a96f1440975889
MD5 ec13579a228ed6e8d9e73855acc90a2c
BLAKE2b-256 1b1f584c15cedcf8c4968dfda95b0e6d99a380534db99eb072d70e31dba71730

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pynxtools_em-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 206.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.6

File hashes

Hashes for pynxtools_em-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 817088eab84d59dca85f84704806a60cd0eb54506773a38a5cfe0b8084873940
MD5 192900a4ccd7ec9d29fb8dc209579f7a
BLAKE2b-256 c6f1672005df30571e942c25543915c43a31f241cae7fec247acba9422886402

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