You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/getting-started.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,12 +15,12 @@ However, to get started, it does not hurt to read the following explanations:
15
15
16
16
You will have
17
17
18
-
- a basic understanding of what this software is about and which capabilities it contains
19
-
- how the different software tools are connected which each other.
18
+
- a basic understanding of what this software is about and its capabilities
19
+
- how the different software tools are interconnected
20
20
21
21
## What is NeXus?
22
22
23
-
NeXus is a framework for describing and standardizing experimental data. NeXus provides domain-specific rules for organizing data within files in addition to a dictionary of well-defined domain-specific field concepts. It helps communities to agree on terms to describe their data, acting as a contract on which data has to be present and how to name them in a given dataset.
23
+
NeXus is a data format intended for describing and standardizing experimental data. NeXus provides a specific grammar and syntactic rules via NXDL (NeXus Definition Language) for organizing data within files in addition to a dictionary of well-defined domain-specific field concepts. Since each individual concept is properly documented, it allows communities to agree on terms describing their data. Thus, NeXus acts as a contract on which concepts have to be present and how to name them in a given dataset.
24
24
25
25
For a more detailed description on the general principles of NeXus we recommend:
26
26
@@ -33,7 +33,7 @@ FAIRmat is one of the consortia of the German National Research Data Infrastruct
33
33
34
34
## What is NOMAD?
35
35
36
-
Within FAIRmat, we develop **NOMAD**: an open source research data management system for making materials science data searchable and publishable. NOMAD can host all kinds of data from materials science - including, but not limited to, NeXus data.
36
+
Within FAIRmat, we develop **NOMAD**: an open source research data management system for making materials science data searchable and publishable. NOMAD hosts a wide variety of datasets from different domains of materials science - including, but not limited to, NeXus data.
@@ -51,7 +51,7 @@ Within FAIRmat, we develop **NOMAD**: an open source research data management sy
51
51
52
52
## Does `pynxtools` require NOMAD or NOMAD OASIS?
53
53
54
-
No. You can use `pynxtools`perfectly fine as a standalone tool for converting data from experiments to NeXus-compliant files. Therefore, this tool acts as the framework to design instances of data within the NeXus universe. The software _can_, however, be used as a **NOMAD plugin** to parse NeXus files, please see the section below for details.
54
+
No. With the available [plugins](./reference/plugins.md) or community-developed plugins, you can use `pynxtools` as a standalone tool for converting raw data from experiments to NeXus-compliant files. Therefore, this tool acts as the framework to design instances of data within the NeXus universe. The software _can_, however, be used as a **NOMAD plugin** to parse NeXus files, please see the section below for details.
0 commit comments