Skip to content

Commit 0e0e340

Browse files
committed
Docs: minor improvements to GUI descriptions.
1 parent ff1389e commit 0e0e340

File tree

2 files changed

+20
-23
lines changed

2 files changed

+20
-23
lines changed

docs/UI-ImGui.md

+10-6
Original file line numberDiff line numberDiff line change
@@ -27,10 +27,10 @@ Insert Configurations:
2727
- Domains
2828
- Spin Spirals
2929

30-
You may manipulate the Hamiltonian as well as simulation parameters and your
30+
You can manipulate the Hamiltonian as well as simulation parameters and your
3131
output file configuration.
3232

33-
You may start and stop simulation and directly interact with a running simulation.
33+
You can start and stop simulation and directly interact with a running simulation.
3434
- LLG Simulation: Dynamics and Minimization
3535
- GNEB: create transitions and calculate minimum energy paths
3636

@@ -106,9 +106,13 @@ Select the GNEB method and one of the minimisation solvers.
106106
In order to perform a geodesic nudged elastic band (GNEB)
107107
calculation, you need to first create a chain of spin systems,
108108
in this context called "images".
109-
You can do this by pressing `ctrl+c` (on mac replace `ctrl` with `cmd`) to "copy" the current image
110-
and then `ctrl+rightarrow` multiple times to insert the copy
111-
into the chain until the desired number of images is reached.
109+
You can set the chain length directly in the field nex to the start/stop button.
110+
111+
You can also manipulate the chain by copying the current image using `ctrl+c`
112+
(on mac replace `ctrl` with `cmd`) and then `ctrl+rightarrow`/`ctrl+leftarrow`
113+
to insert the copy into the chain and `ctrl+v` to overwrite the current image.
114+
See the help menu for all keybindings.
115+
112116
The GUI will show the length of the chain:
113117

114118
![GUI controls](https://i.imgur.com/LDTSkwC.png "GUI controls")
@@ -157,7 +161,7 @@ Key bindings
157161
| Cycle Method | <kbd>Ctrl</kbd>+<kbd>M</kbd> |
158162
| Cycle Solver | <kbd>Ctrl</kbd>+<kbd>S</kbd> |
159163

160-
### Manipulate the current images
164+
### Manipulate the current image
161165

162166
| Effect | Keystroke |
163167
| -------------------------------------- | :---------------------------------: |

docs/UI-Qt.md

+10-17
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,10 @@ Insert Configurations:
2121
- Domains
2222
- Spin Spirals
2323

24-
You may manipulate the Hamiltonian as well as simulation parameters and your
24+
You can manipulate the Hamiltonian as well as simulation parameters and your
2525
output file configuration.
2626

27-
You may start and stop simulation and directly interact with a running simulation.
27+
You can start and stop simulation and directly interact with a running simulation.
2828
- LLG Simulation: Dynamics and Minimization
2929
- GNEB: create transitions and calculate minimum energy paths
3030

@@ -94,9 +94,13 @@ Select the GNEB method and the VP solver.
9494
In order to perform a geodesic nudged elastic band (GNEB)
9595
calculation, you need to first create a chain of spin systems,
9696
in this context called "images".
97-
You can do this by pressing `ctrl+c` to "copy" the current image
98-
and then `ctrl+rightarrow` multiple times to insert the copy
99-
into the chain until the desired number of images is reached.
97+
You can set the chain length directly in the field nex to the start/stop button.
98+
99+
You can also manipulate the chain by copying the current image using `ctrl+c`
100+
(on mac replace `ctrl` with `cmd`) and then `ctrl+rightarrow`/`ctrl+leftarrow`
101+
to insert the copy into the chain and `ctrl+v` to overwrite the current image.
102+
See the help menu for all keybindings.
103+
100104
The GUI will show the length of the chain:
101105

102106
![GUI controls](https://imgur.com/y3VhqBj.png "GUI controls")
@@ -148,25 +152,14 @@ Key bindings
148152
| Cycle Method | <kbd>Ctrl</kbd>+<kbd>M</kbd> |
149153
| Cycle Solver | <kbd>Ctrl</kbd>+<kbd>S</kbd> |
150154

151-
### Manipulate the current images
155+
### Manipulate the current image
152156

153157
| Effect | Keystroke |
154158
| -------------------------------------- | :---------------------------------: |
155159
| Random configuration | <kbd>Ctrl</kbd>+<kbd>R</kbd> |
156160
| Add tempered noise | <kbd>Ctrl</kbd>+<kbd>N</kbd> |
157161
| Insert last used configuration | <kbd>Enter</kbd> |
158162

159-
### Visualisation
160-
161-
| Effect | Keystroke |
162-
| ------------------------------------------------ | :-----------------------------------------: |
163-
| Use more/less data points of the vector field | <kbd>+/-</kbd> |
164-
| Regular Visualisation Mode | <kbd>1</kbd> |
165-
| Isosurface Visualisation Mode | <kbd>2</kbd> |
166-
| Slab (X,Y,Z) Visualisation Mode | <kbd>3</kbd> <kbd>4</kbd> <kbd>5</kbd> |
167-
| Cycle Visualisation Mode | <kbd>/</kbd> |
168-
| Move Slab | <kbd>,</kbd> / <kbd>.</kbd> ( <kbd>Shift</kbd> to go faster) |
169-
170163
### Manipulate the chain of images
171164

172165
| Effect | Keystroke |

0 commit comments

Comments
 (0)