Skip to content

Commit

Permalink
improve description of iv_temp example
Browse files Browse the repository at this point in the history
  • Loading branch information
lukaspie committed Nov 27, 2024
1 parent 0f677ee commit 5a0bf06
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
4 changes: 2 additions & 2 deletions src/pynxtools/nomad/entrypoints.py
Original file line number Diff line number Diff line change
Expand Up @@ -69,8 +69,8 @@ def load(self):
title="Sensor Scan - IV Temperature Curve",
category="FAIRmat examples",
description="""
This example shows users how to take data from a Python framework and map it out to a Nexus application definition for IV Temperature measurements, [NXiv_temp](https://fairmat-experimental.github.io/nexus-fairmat-proposal/1c3806dba40111f36a16d0205cc39a5b7d52ca2e/classes/contributed_definitions/NXiv_temp.html#nxiv-temp).
We use the Nexus ELN features of Nomad to generate a Nexus file.
This example shows users how to take data from a Python framework and map it out to a Nexus application definition for IV Temperature measurements, [`NXiv_temp`](https://fairmat-nfdi.github.io/nexus_definitions/classes/contributed_definitions/NXiv_temp.html).
We use the Nexus ELN features of NOMAD to generate a Nexus file.
""",
plugin_package="pynxtools",
resources=["nomad/examples/iv_temp/*"],
Expand Down
8 changes: 4 additions & 4 deletions src/pynxtools/nomad/examples/iv_temp/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@

# Introduction

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

This specific data was capured using a Bluesky controlled system. This was then saved into a binary file using Pickle. This example shows how such a dataset could be converted using the JSONMapReader of the NexusParser.
The data is mapped on to a Nexus application definition for IV Temperature measurements, [NXiv_temp](https://fairmat-experimental.github.io/nexus-fairmat-proposal/50433d9039b3f33299bab338998acb5335cd8951/classes/contributed_definitions/NXiv_temp.html#nxiv-temp).
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-xps).
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).

# Viewing uploaded data

Expand All @@ -21,7 +21,7 @@ To do so open the **FILES** tab and just select a `.nxs` file.
# Using a Jupyter Notebook

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

# Where to go from here?

Expand Down

0 comments on commit 5a0bf06

Please sign in to comment.