8000 deprecation of ellipsometry reader in favor of its own pynxtools-ellips plugin by RonHildebrandt · Pull Request #322 · FAIRmat-NFDI/pynxtools · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content
8000

deprecation of ellipsometry reader in favor of its own pynxtools-ellips plugin #322

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 3, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,15 +53,17 @@ data into the NeXus standard and visualising the files content.
Documentation for the different tools can be found [here](https://fairmat-nfdi.github.io/pynxtools/).

# Plugins
There are a number of plugins available for pynxtools. These are extensions of pynxtools used for reading data of specialized experimental techniques.
There are a number of plugins available for pynxtools. These are extensions of pynxtools used for reading data of specific experimental techniques.
- [**pynxtools-mpes**](https://github.com/FAIRmat-NFDI/pynxtools-mpes): A reader for multi-dimensional photoelectron spectroscopy data.
- [**pynxtools-stm**](https://github.com/FAIRmat-NFDI/pynxtools-stm): A reader for scanning tunneling microscopy (SPM) and spectroscopy (STS) data.
- [**pynxtools-xps**](https://github.com/FAIRmat-NFDI/pynxtools-xps): A reader for X-ray photoelectron spectroscopy (XPS) data.

Respective readers for the research fields of electron microscopy and atom probe are currently refactored into pynxtools plugins.
Until this refactoring will have become completed, users are advised to use the apm and em readers via pynxtools<=0.1.1.
- [**pynxtools-apm**](https://github.com/FAIRmat-NFDI/pynxtools-apm): A reader for atom probe as well as related field ion microscopy data.
- [**pynxtools-em**](https://github.com/FAIRmat-NFDI/pynxtools-em): A reader for electron microscopy data.
- [**pynxtools-ellips**](https://github.com/FAIRmat-NFDI/pynxtools-ellips): A reader for ellipsometry data.

Note that pynxtools-apm and pynxtools-em are currently refactored into pynxtools plugins.
Until this refactoring will have become completed, users are advised to use the apm and em readers via pynxtools<=0.1.1.


You can install each of the plugins together with `pynxtools` by passing the name of the plugin as an extra to the pip install call. For example, for the `pynxtools-mpes` plugin:
```shell
Expand Down
18 changes: 5 additions & 13 deletions examples/README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
## Getting started
We offer examples of how you can convert your data (raw data, numerical data, metadata),
We offer examples of how you can convert your data (raw data, numerical data, metadata),
from your acquisition software or electronic lab notebook (ELN), into a NeXus/HDF5 file
using the [dataconverter](../pynxtools/dataconverter) tool.
This tool offers parsers/readers/data extractors for various experimental techniques, including
electron microscopy, photo-emission spectroscopy, optical spectroscopy, atom probe, and other
techniques. Please refer to the individual README's in each sub-directory for details.
This tool offers parsers/readers/data extractors for various experimental techniques via
technique specific plugins.

The examples contain code snippets for creating a NeXus/HDF5 file for the experimental technique
according to a standardized application definition (e.g. NXem, NXmpes, NXellipsometry, NXapm).
according to a standardized NeXus application definition (e.g. NXem, NXmpes, NXellipsometry,
NXapm, NXopt, NXxps, NXraman).
Respective [Jupyter Notebooks](https://jupyter.org/) are used for running these examples.

There is also a documentation of the [dataconverter](../pynxtools/dataconverter) available.
Expand All @@ -18,11 +18,3 @@ us if you need help.
For giving specific feedback to specific parsers/readers/data extractors please contact the
respective developers directly and checkout the domain-specific pynxtools plugins:

### em_om, em_spctrscpy
Markus Kühbach

### mpes, xps
Florian Dobner, Rubel Mozumder, Lukas Pielsticker

### ellipsometry
Carola Emminger, Florian Dobner
19 changes: 0 additions & 19 deletions examples/ellipsometry/README.md

This file was deleted.

69 changes: 0 additions & 69 deletions examples/ellipsometry/eln_data.yaml

This file was deleted.

Loading
0