Skip to content

Commit 6daf88b

Browse files
Apply suggestions from code review
Co-authored-by: RubelMozumder <32923026+RubelMozumder@users.noreply.github.com>
1 parent cdcfa07 commit 6daf88b

File tree

3 files changed

+9
-7
lines changed

3 files changed

+9
-7
lines changed

.github/workflows/build_docs.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,9 @@ jobs:
3131
- name: Check spelling
3232
uses: streetsidesoftware/cspell-action@v7
3333
with:
34-
files: "docs/**/*.md"
34+
files:
35+
- "docs/**/*.md"
36+
- "README.md"
3537
config: cspell.json
3638
strict: true
3739
incremental_files_only: false

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
<table align="center">
1212
<tr><td align="center" width="10000">
1313

14-
# <strong> pynxtools: FAIR data handling using NeXuss </strong>
14+
# <strong> pynxtools: FAIR data handling using NeXus </strong>
1515
</td></tr></table>
1616

1717

docs/getting-started.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,12 @@ However, to get started, it does not hurt to read the following explanations:
1515

1616
You will have
1717

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
2020

2121
## What is NeXus?
2222

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.
2424

2525
For a more detailed description on the general principles of NeXus we recommend:
2626

@@ -33,7 +33,7 @@ FAIRmat is one of the consortia of the German National Research Data Infrastruct
3333

3434
## What is NOMAD?
3535

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.
3737

3838
- [NOMAD Homepage](https://nomad-lab.eu/)
3939
- [NOMAD documentation](https://nomad-lab.eu/prod/v1/staging/docs/)
@@ -51,7 +51,7 @@ Within FAIRmat, we develop **NOMAD**: an open source research data management sy
5151

5252
## Does `pynxtools` require NOMAD or NOMAD OASIS?
5353

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.
5555

5656
## How to use `pynxtools` with NOMAD
5757

0 commit comments

Comments
 (0)