Skip to content

Commit bcbd68f

Browse files
committed
add a sentence on plugins in getting started
1 parent cf71de5 commit bcbd68f

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

docs/getting-started.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,8 @@ Within FAIRmat, we develop **NOMAD**: an open source research data management sy
4242

4343
`pynxtools` is our main software tool for end-to-end handling of data from experiments using NeXus. It contains a parser for combining various instrument output formats and electronic lab notebook (ELN) formats into an [HDF5](https://support.hdfgroup.org/HDF5/) file according to NeXus application definitions. It provides validation against these NeXus definitions and can be used to annotate existing NeXus files with semantic meaning.
4444

45+
`pynxtools` acts as a Python framework with a built-in API for writing [reader plugins](reference/plugins.md) that provide specialized reading and conversion functionality for different domains of materials science.
46+
4547
`pynxtools` can be used for standalone NeXus conversion, but it can also be used as a _plugin_ to NOMAD, extending NOMAD schemas and parsing capabilities with NeXus-specific capabilities.
4648

4749
## How can I install pynxtools? How can I contribute?

0 commit comments

Comments
 (0)