Skip to content

Commit a07a758

Browse files
lukaspiemkuehbach
andauthored
Apply suggestions from code review
Co-authored-by: Markus Kühbach <mkuehbach@users.noreply.github.com>
1 parent 2420de2 commit a07a758

File tree

2 files changed

+11
-11
lines changed

2 files changed

+11
-11
lines changed

src/pynxtools/nomad/example_uploads/__init__.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -28,13 +28,13 @@
2828
category="NeXus Experiment Examples",
2929
description="""
3030
Sensor Scan - IV Temperature Curve
31-
This example shows how experimental data can be mapped to a Nexus application definition.
32-
Here, data from an IV Temperature measurements as taken by a Python framework is
33-
converted to [`NXiv_temp`](https://fairmat-nfdi.github.io/nexus_definitions/classes/contributed_definitions/NXiv_temp.html).
34-
We also demonstrate the use of Nexus ELN features of NOMAD to add further details
31+
This example shows how experimental data can be mapped to a NeXus application definition.
32+
Here, data from an IV (voltage-vs-current) temperature measurements as taken by a Python framework is
33+
converted to a NeXus/HDF5 file that complies with the [`NXiv_temp`](https://fairmat-nfdi.github.io/nexus_definitions/classes/contributed_definitions/NXiv_temp.html) application definition.
34+
We also demonstrate the use of NeXus ELN features of NOMAD to add further details
3535
which were not provided by the data acquisition software.
3636
This example demonstrates how
37-
- a NOMAD ELN can be built and its content can be written to an RDM platform agnostic yaml format
37+
- a NOMAD ELN can be built and its content written to a yaml file that is RDM platform agnostic
3838
- NOMAD ELN can be used to combine ELN data with experiment data and export them to NeXus
3939
- NeXus data is represented as an Entry with searchable quantities in NOMAD
4040
- NORTH tools can be used to work with data in NOMAD uploads

src/pynxtools/nomad/example_uploads/iv_temp_example/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# Introduction
22

3-
This is an example of a PID controlled sensor sweep scan. The temperature is set using a PID controller. Then, for the set temperature, a voltage sweep is performed. For each of the voltages, the current is measured. This is repeated for a given list of temperatures.
3+
This is an example of a PID controlled sensor sweep scan. The temperature is set using a PID controller. Multiple experiments at different temperatures are performed. For each, a voltage sweep is performed, recording voltage over current.
44

5-
This specific data was captured using a Bluesky controlled system. This was then saved into a binary file using Pickle. This example illustrates how such a dataset could be converted using the [`JSONMapReader`](https://github.com/FAIRmat-NFDI/pynxtools/tree/master/src/pynxtools/dataconverter/readers/json_map) of the NOMAD plugin [`pynxtools`](https://github.com/FAIRmat-NFDI/pynxtools).
6-
The data is mapped on to a Nexus application definition for temperature-dependent IV curve measurements, [NXiv_temp](https://fairmat-nfdi.github.io/nexus_definitions/classes/contributed_definitions/NXiv_temp.html).
5+
This specific data was captured using a [Bluesky](https://blueskyproject.io/) controlled system, writing to a binary file using Pickle. This example illustrates how such a dataset could be converted using the [`JSONMapReader`](https://github.com/FAIRmat-NFDI/pynxtools/tree/master/src/pynxtools/dataconverter/readers/json_map) of the NOMAD plugin [`pynxtools`](https://github.com/FAIRmat-NFDI/pynxtools).
6+
The data are mapped onto the NeXus application definition [NXiv_temp](https://fairmat-nfdi.github.io/nexus_definitions/classes/contributed_definitions/NXiv_temp.html) that was developed for documenting temperature-dependent IV curve measurements.
77

88
## Viewing uploaded data
99

@@ -18,11 +18,11 @@ To do so open the **FILES** tab and just select a `.nxs` file.
1818

1919
## Using a Jupyter Notebook
2020

21-
This example comes with a very simple Jupyter Notebook that shows how one could easily get access to a Python environment with access to all your data in one place.
22-
To give this a go, click the **FILES** tab and select `IV_temp.ipynb`. Feel free to modify this or just create a new one to try!
21+
This example comes with a simple Jupyter Notebook that shows how one could easily get access to a Python environment with access to all your data in one place.
22+
To give this a go, click the **FILES** tab and select `IV_temp.ipynb`. Feel free to modify this notebook or just create a new one to try!
2323

2424
## Where to go from here?
2525

26-
If you're interested in using this pipeline and NOMAD in general you'll find support at [FAIRmat](https://www.fairmat-nfdi.eu/fairmat/consortium).
26+
If you're interested in using this pipeline and NOMAD in general, you'll find support at [FAIRmat](https://www.fairmat-nfdi.eu/fairmat/consortium).
2727

2828
If you have any questions about this example you may contact [Sherjeel Shabih](https://www.fairmat-nfdi.eu/fairmat/fairmat_/fairmatteam) from the FAIRmat consortium.

0 commit comments

Comments
 (0)