Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Integrate pynxtools igor #481

Merged
merged 6 commits into from
Dec 9, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .github/workflows/plugin_test.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,9 @@ jobs:
- plugin: pynxtools-em
branch: main
tests_to_run: tests/.
- plugin: pynxtools-igor
branch: main
tests_to_run: tests/.
- plugin: pynxtools-mpes
branch: main
tests_to_run: tests/.
Expand Down
8 changes: 6 additions & 2 deletions docs/reference/plugins.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Plugins
There are a number of plugins available for pynxtools that are maintained within FAIRmat. These are extensions of pynxtools used for reading data of specific experimental techniques.
There are a number of plugins available for pynxtools that are maintained within FAIRmat. These are extensions of pynxtools used for reading data of specific experimental techniques and/or file formats.

### Photoemission spectroscopy
- [**pynxtools-mpes**](https://github.com/FAIRmat-NFDI/pynxtools-mpes): A reader for multi-dimensional photoelectron spectroscopy (MPES) data.
Expand All @@ -20,8 +20,12 @@ There are a number of plugins available for pynxtools that are maintained within
- [**pynxtools-stm**](https://github.com/FAIRmat-NFDI/pynxtools-stm): A reader for scanning tunneling microscopy (SPM) and spectroscopy (STS) data.

### X-ray diffraction
- [**pynxtools-xrd**](https://github.com/FAIRmat-NFDI/pynxtools-raman): A reader for X-ray diffraction data.
- [**pynxtools-xrd**](https://github.com/FAIRmat-NFDI/pynxtools-xrd): A reader for X-ray diffraction data.

### Others
- [**pynxtools-igor**](https://github.com/FAIRmat-NFDI/pynxtools-igor): A general reader for [Igor Pro](https://www.wavemetrics.com/) Binary Wave data. Documentation can be found [here](https://fairmat-nfdi.github.io/pynxtools-igor/).




## Installation
Expand Down
5 changes: 4 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ dev = [
"pre-commit",
]
convert = [
"pynxtools[apm,em,mpes,xps,stm,xrd,ellips,raman]",
"pynxtools[apm,ellips,em,igor,mpes,raman,stm,xps,xrd]",
]

apm = [
Expand All @@ -76,6 +76,9 @@ ellips = [
em = [
"pynxtools-em>=0.3.1",
]
igor = [
"pynxtools-igor>=0.1.0",
]
mpes = [
"pynxtools-mpes>=0.2.1",
]
Expand Down
2 changes: 1 addition & 1 deletion src/pynxtools/nomad/examples/iv_temp/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

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 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).
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).
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 Down
Loading