From 355e1f99fb4f6031de2c4fa047a601e695e8c6a9 Mon Sep 17 00:00:00 2001 From: Lukas Pielsticker <50139597+lukaspie@users.noreply.github.com> Date: Wed, 31 Jan 2024 14:43:15 +0100 Subject: [PATCH] update main, nexus, generate_eln readmes --- README.md | 4 ++++ pynxtools/eln_mapper/README.md | 11 ++++++----- pynxtools/nexus/README.md | 2 +- 3 files changed, 11 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 26a96f86a..9772aa6c2 100644 --- a/README.md +++ b/README.md @@ -43,6 +43,10 @@ data into the NeXus standard and visualising the files content. - [**dataconverter**](https://github.com/FAIRmat-NFDI/pynxtools/blob/master/pynxtools/dataconverter/README.md): Creates compliant instances of NeXus/HDF5 files to [NeXus schemas](https://nexusformat.org). - [**read_nexus**](https://github.com/FAIRmat-NFDI/pynxtools/blob/master/pynxtools/nexus/README.md): Outputs a debug log for a given NeXus file. +- [**generate_eln**](https://github.com/FAIRmat-NFDI/pynxtools/blob/master/pynxtools/eln_mapper/README.md): Outputs ELN files that can be used to add metadata to the dataconverter routine. + +# Documentation +Documentation for the different tools can be found [here](https://fairmat-nfdi.github.io/pynxtools/). # Contributing diff --git a/pynxtools/eln_mapper/README.md b/pynxtools/eln_mapper/README.md index 13f759466..dd6c58faf 100644 --- a/pynxtools/eln_mapper/README.md +++ b/pynxtools/eln_mapper/README.md @@ -1,10 +1,11 @@ # ELN generator -This is a helper tool for generating eln -- The simple eln generator that can be used in a console or jupyter-notebook -- Scheme based eln generator that can be used in NOMAD and the eln can be used as a custom scheme in NOMAD. +This is a helper tool for generating ELN files that can be used to add metadata to the dataconverter routine. +Two types of ELN are supported (by passing the flag `eln-type`): +- [**eln**]: The simple ELN generator that can be used in a console or jupyter-notebook. +- [**scheme_eln**]: Scheme based ELN generator that can be used in NOMAD and the ELN can be used as a custom scheme in NOMAD. ``` -$ eln_generator --options +$ generate_eln --options Options: --nxdl TEXT Name of NeXus definition without extension @@ -14,6 +15,6 @@ Options: /Entry[ENTRY]/Instrument[INSTRUMENT]/... will be skiped. [default: 1] --output-file TEXT Name of output file. - --eln-type [eln|scheme_eln] Choose a type from the eln or scheme_eln. [required] + --eln-type [eln|scheme_eln] Choose a type of ELN output (eln or scheme_eln). [required] --help Show this message and exit. ``` diff --git a/pynxtools/nexus/README.md b/pynxtools/nexus/README.md index 0762bc4e5..e8357f75f 100644 --- a/pynxtools/nexus/README.md +++ b/pynxtools/nexus/README.md @@ -35,4 +35,4 @@ export 'NEXUS_DEF_PATH'= Following example dataset can be used to test `read_nexus` module `tests/data/nexus/201805_WSe2_arpes.nxs`. This is an angular-resolved photoelectron spectroscopy (ARPES) dataset and it is formatted according to -the [NXarpes application definition of NEXUS](https://manual.nexusformat.org/classes/applications/NXarpes.html#nxarpes). \ No newline at end of file +the [NXarpes application definition of NeXus](https://manual.nexusformat.org/classes/applications/NXarpes.html#nxarpes). \ No newline at end of file