updated readme

README.md

@@ -1,45 +1,65 @@
 # 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
+I recommend installing using [uv](https://github.com/astral-sh/uv). Follow uv's installation instructions if you don't already have it. You can check (and update) by running the following command in a terminal:
+```sh
+uv self update
+```
+You may need to close and re-open your terminal after uv's first installation for all the changes to take effect.
 
-2. activate said environment
+Install `dispersionapp` by running
+```sh
+uv tool install https://git.dedebenui.me/dedebenui/dispersionapp.git
+```
 
-conda activate app-env
+To update an existing installation, run
+```sh
+uv tool install --upgrade https://git.dedebenui.me/dedebenui/dispersionapp.git
+```
 
-3. 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:
+Check that everything works by running
-
+```
-pip install http://130.92.113.172/dispersionapp.zip
+dispersionapp --version
+```
 
 # Usage
 
-1. Make sure your environment is activated (step 1 above)
+Run the app with the command:
-
+```sh
-2. call the `dispersionapp` command
-
 dispersionapp
+```
 
-2*. this can be also done via calling python first (`-m` tells python to open the specified module)
+Run `dispersionapp --help` to see available options.
 
-python -m dispersionapp
+The app saves a config file in your home directory. If you want to specify a custom config file location, use the `-c / --config` option. For example:
+```sh
+dispersionapp -c my_config.toml
+```
+This will create the file `my_config.toml` in your current working directory if it doesn't already exist.
+
+Selecting the gas is not part of the GUI. To change it, you can either manually modify the configuration file, or you can run `dispersionapp` with the `-g / --gas` option:
+```sh
+dispersionapp --gas helium
+```
+This will start the app with Helium selected and save it in the config. Subsequent starts will remember this selection, unless you start the app with a different config file, or move/delete/rename the existing one.
 
 # 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 :
+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 parameter.
-- 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. Possible values are hard-coded. I might add an option for custom values later on.
+- 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
+- Left-click and drag to move around.
-- right-click+drag to zoom
+- Right-click and drag to zoom.
-- scroll wheel 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.
+- For each of these movements, 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 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 and drag the legend to move it around.
-- click+drag on the purble title bar to move plots around (it's a bit buggy)
+- Click and drag between two plots to resize them.
-- double click on the purple title bar (left side or top) to pop out the plot in its own window.
+- Click and drag on the purple 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.