dedebenui/dispersionapp
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

better help text

Browse Source
This commit is contained in:
Benoît Sierro
2023-07-10 16:44:22 +02:00
parent 161f7dd8ea
commit e38c5b87ee
1 changed files with 9 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@@ -25,20 +25,21 @@ python -m dispersionapp
# Interface # Interface
On the top left, you will see a summary of the current configuration. On the right, you will find the paremter list. At the very top is a summary of the configuration as well as a few physical properties derived from the current parameters.
from left to right : Below, you will find the parameter list. Each parameter has a couple elements. From left to right :
- the name of the paramter - the name of the paramter
- a slider to quickly explore values - a slider to quickly explore values
- arrow buttons to move from one value to the next - arrow buttons to move from one value to the next.
- a text box where you can input your desired value. The closest possible value will then be selected. - a text box where you can input your desired value. The closest possible value will then be selected. Possible values are hard-coded. I might add an option for custom values later on.
To navigate the plot: To navigate the plot:
- left-click + drag to move around - left-click+drag to move around
- right-click + drag to zoom - right-click+drag to zoom
- scroll wheel to zoom - scroll wheel to zoom
- for each kind of movement, you can do it while the cursor is hovering over one of the axis. In that case, only that axis is affected. - for each of these movement, you can do it while the cursor is hovering over one of the axis. In that case, only that axis is affected.
- to go back to a view that fits everything, click on the small "A" at the bottom left. This is not ideal for the disperion plot, so you can find another reset button in the parameter list. - to go back to a view that fits everything, click on the small "A" at the bottom left. This is not ideal for the dispersion plot because of all the resonances, so you can find another reset button in the parameter list.
- to hide/show a line, click on it in the legend. You can also click+drag on the legend to move it around. - to hide/show a line, click on it in the legend. You can also click+drag on the legend to move it around.
- click+drag on the purble title bar to move plots around (it's a bit buggy)
- double click on the purple title bar (left side or top) to pop out the plot in its own window. - double click on the purple title bar (left side or top) to pop out the plot in its own window.