Skip to content

Commit

Permalink
Update examples and readme
Browse files Browse the repository at this point in the history
  • Loading branch information
lukaspie committed Feb 20, 2024
1 parent 5a791a9 commit 3b4eb10
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 8 deletions.
9 changes: 4 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,21 +14,21 @@ Learn how to manage [python versions](https://github.com/pyenv/pyenv) and
Install this package with

```shell
pip install git+https://github.com/FAIRmat-NFDI/pynxtools_xps.git
pip install git+https://github.com/FAIRmat-NFDI/pynxtools-xps.git
```

for the latest development version.


# Purpose
This pynxtools reader plugin is used to translate diverse file formats from the scientific community and technology partners
This reader plugin for [pynxtools](https://github.com/FAIRmat-NFDI/pynxtools) is used to translate diverse file formats from the scientific community and technology partners
within the field of X-ray photoelectron spectroscopy into a standardized representation using the
[NeXus](https://www.nexusformat.org/) application definition [NXmpes](https://fairmat-nfdi.github.io/nexus_definitions/classes/contributed_definitions/NXmpes.html#nxmpes).

## Supported file formats
The reader decides which parser to use based on the file extension of the files provided. For the main XPS files, the following file extensions are supported:
- .sle: [SpecsLabProdigy](https://www.specs-group.com/nc/specs/products/detail/prodigy/) files, propietary format of SPECS GmbH (v1.6)
- .xml: SpecsLab 2files, XML format from SPECS GmbH (v1.6)
- .xml: SpecsLab 2files, XML format from SPECS GmbH (v1 and v4)
- .vms: VAMAS files, ISO standard data transfer format ([ISO 14976](https://www.iso.org/standard/24269.html)), both in regular and irregular format
- .xy: SpecsLabProdigy export format in XY format (including all export settings)
- .txt:
Expand All @@ -47,8 +47,7 @@ An example script to run the XPS reader in pynxtools:
--input-file $<eln-file path> \
--output <output-file path>.test.nxs
```
Note that none of the supported file format have data/values for all required and recommended fields and attributes in NXmpes. In order for the validation step of the **XPS** reader to pass,
you need to provide an ELN file that contains the missing values. An example can be found in [*pynxtools_xps/examples*](https://github.com/FAIRmat-NFDI/pynxtools-xps/tree/main/examples).
Note that none of the supported file format have data/values for all required and recommended fields and attributes in NXmpes. In order for the validation step of the XPS reader to pass, you need to provide an ELN file that contains the missing values. An example can be found in [*pynxtools_xps/examples*](https://github.com/FAIRmat-NFDI/pynxtools-xps/tree/main/examples).


# Contributing
Expand Down
Binary file added examples/.sle/Au_25_mbar_O2_no_align.nxs
Binary file not shown.
12 changes: 12 additions & 0 deletions examples/.sle/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Example for .sle data

This is an example for the [SpecsLabProdigy](https://www.specs-group.com/nc/specs/products/detail/prodigy/) .sle files, which is the propietary format of SPECS GmbH. The SpecsLabProdigy software version is v4.63.1. The example conversion can be run with the following command.

```console
user@box:~$ dataconverter --params-file params.yaml
```

Not that the `params.yaml` file contains the `remove_align` keyword which is special for the SLE parser. It allows removal of alignment spectra that were taken during the experiment. For this example, it considerably speeds up the conversion.

## Contact person in FAIRmat for this example
Lukas Pielsticker
6 changes: 3 additions & 3 deletions examples/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# XPS Reader
# Examples for the XPS

## What is this reader?
Here, you can find working examples of XPS-to-NeXus conversion using the latest [NXmpes](https://fairmat-nfdi.github.io/nexus_definitions/classes/contributed_definitions/NXmpes.html#nxmpes) application definition and the latest development version of pynxtools-xps.

This reader supports converting X-ray photoelectron spectroscopy into a NeXus formatted file. The application definiton it follows is [NXmpes](https://fairmat-nfdi.github.io/nexus_definitions/classes/contributed_definitions/NXmpes.html#nxmpes).
This reader supports converting X-ray photoelectron spectroscopy into a NeXus formatted file. The it follows is .

## Supported file formats
The reader decides which parser to use based on the file extension of the files provided. For the main XPS files, the following file extensions are supported:
Expand Down

0 comments on commit 3b4eb10

Please sign in to comment.