nqrduck/nqrduck
1
0
Fork 0
mirror of https://github.com/nqrduck/nqrduck.git synced 2024-05-19 16:13:58 +00:00
Code Issues Packages Projects Releases Wiki Activity

Added UI example to README:

Browse source
This commit is contained in:
jupfi 2024-02-22 11:42:51 +01:00
parent 8dfd78b8ac
commit aa0186417c
2 changed files with 6 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
README.md
View file

@ -19,6 +19,12 @@
## Usage
Individual features of the software can be installed as separate Python packages, like spectrometer control, pulse sequence programming or simulation of magnetic resonance experiments. The available functionality of the NQRduck program therefore depends on the installed packages.
The UI is structured as follows:
<img src="docs/img/ui_structure_v2.png" alt="drawing" width="800">
The UI is separated into different areas. Section 'a', highlighted in red, represents the menu bar used for general settings of the program and spectrometer selection. Section 'b', outlined in green, allows switching among various modules within the main view of the core, with the active module displayed in bold. Section 'c', depicted in blue, is the active module's view. The currently active module in the figure is the [nqrduck-measurement](https://github.com/nqrduck/nqrduck-measurement) module used for single frequency mangetic resonance experiments. The overall application is part of the NQRduck core and opens when the NQRduck core is started.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details

BIN
docs/img/ui_structure_v2.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 1.4 MiB