Skip to content
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.

Sign up for GitHub

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

Update main, nexus, generate_eln READMEs #226

Merged
merged 3 commits into from
Jan 31, 2024
Merged

Update main, nexus, generate_eln READMEs #226

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
355e1f9
update main, nexus, generate_eln readmes
lukaspie Jan 31, 2024
1adef84
typo fix in generate_eln readme
lukaspie Jan 31, 2024
5599c3d
use generate_eln --help in readme
lukaspie Jan 31, 2024
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
4 changes: 4 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
11 changes: 6 additions & 5 deletions pynxtools/eln_mapper/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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 <value>
$ generate_eln --options <value>
lukaspie marked this conversation as resolved.
Show resolved Hide resolved
lukaspie marked this conversation as resolved.
Show resolved Hide resolved

Options:
--nxdl TEXT Name of NeXus definition without extension
Expand All @@ -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.
```
2 changes: 1 addition & 1 deletion pynxtools/nexus/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,4 +35,4 @@ export 'NEXUS_DEF_PATH'=<folder_path_that_contains_nexus_defs>

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).
the [NXarpes application definition of NeXus](https://manual.nexusformat.org/classes/applications/NXarpes.html#nxarpes).
Loading