Files
dispersionapp/README.md
Benoît Sierro e38c5b87ee better help text
2023-07-10 16:44:22 +02:00

2.1 KiB

Installation

  1. If not already done so, create a virtual environment to contain all the packages required. Python 3.10 is recommended. The command below will create a new environment named 'app-env' with the latest version of Python 3.10.

conda create -y -n app-env python=3.10

  1. activate said environment

conda activate app-env

  1. The prompt should now read '(app-env)' on the left. The app is not published on Github or anywhere else. The link below points to the webserver running on the FibNas server. You are now ready to install everything with this command:

pip install http://130.92.113.172/dispersionapp.zip

Usage

  1. Make sure your environment is activated (step 1 above)

  2. call the dispersionapp command

dispersionapp

2*. this can be also done via calling python first (-m tells python to open the specified module)

python -m dispersionapp

Interface

At the very top is a summary of the configuration as well as a few physical properties derived from the current parameters.

Below, you will find the parameter list. Each parameter has a couple elements. From left to right :

  • the name of the paramter
  • a slider to quickly explore values
  • 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. Possible values are hard-coded. I might add an option for custom values later on.

To navigate the plot:

  • left-click+drag to move around
  • right-click+drag to zoom
  • scroll wheel to zoom
  • 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 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.
  • 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.