-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #450 from FAIRmat-NFDI/fix-link-in-docs
fix link in docs
- Loading branch information
Showing
4 changed files
with
9 additions
and
83 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.