Skip to content

Commit

Permalink
Merge pull request #450 from FAIRmat-NFDI/fix-link-in-docs
Browse files Browse the repository at this point in the history
fix link in docs
  • Loading branch information
lukaspie authored Oct 10, 2024
2 parents bda1ed3 + 557f6df commit 6b62c25
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 83 deletions.
2 changes: 1 addition & 1 deletion docs/tutorial/converting-data-to-nexus.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ We will use the [XPS reader plugin](https://github.com/FAIRmat-NFDI/pynxtools-xp

#### Steps

1. Download the example files from here: [Example files](https://download-directory.github.io/?url=https://github.com/FAIRmat-NFDI/pynxtools-xps/tree/main/examples/sle)
1. Download the example files from here: [Example files](https://download-directory.github.io/?url=https://github.com/FAIRmat-NFDI/pynxtools-xps/tree/main/examples/specs/sle)
2. **Extract** the zip and copy the files in your current working directory. You can find the working directory by typing the following in your terminal:
```console
pwd
Expand Down
23 changes: 8 additions & 15 deletions examples/README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,13 @@
## Getting started
We offer examples of how you can convert your data (raw data, numerical data, metadata),
Here, we provide 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 via
technique specific plugins.
using the [built-in readers of pynxtools](https://fairmat-nfdi.github.io/pynxtools/reference/built-in-readers.html).

The examples contain code snippets for creating a NeXus/HDF5 file for the experimental technique
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 [documentation](https://fairmat-nfdi.github.io/pynxtools/learn/dataconverter-and-readers.html) of the [dataconverter](../src/pynxtools/dataconverter/README.md) available. You can write a reader plugin if the data for your experimental technique is not supported yet, see documentation [here](https://fairmat-nfdi.github.io/pynxtools/how-tos/build-a-plugin.html).

There is also a documentation of the [dataconverter](../pynxtools/dataconverter) available.
You can also write a [reader](../pynxtools/dataconverter/readers) for your experimental technique
if it is not supported yet. Feel also free to [contact](../README.md#questions-suggestions)
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:
Note that `pynxtools` offers a number of FAIRmat-supported parsers/readers/data extractors for various experimental techniques via
technique specific plugins. You can find the list [here](https://fairmat-nfdi.github.io/pynxtools/reference/plugins.html). You can find
examples for using each of them in the individual repositories and in their documentation.

For giving feedback to specific parsers/readers/data extractors, please checkout the domain-specific `pynxtools` plugins and their examples
or contact the respective developers directly.
35 changes: 0 additions & 35 deletions examples/mpes/README.md

This file was deleted.

32 changes: 0 additions & 32 deletions examples/sts/README.md

This file was deleted.

0 comments on commit 6b62c25

Please sign in to comment.