58 lines
1.9 KiB
Markdown
58 lines
1.9 KiB
Markdown
# Installation
|
|
|
|
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.
|
|
|
|
Install `linemeasurement` by running
|
|
```sh
|
|
uv tool install https://git.dedebenui.me/dedebenui/linemeasurement.git
|
|
```
|
|
|
|
To update an existing installation, run
|
|
```sh
|
|
uv tool install --upgrade https://git.dedebenui.me/dedebenui/linemeasurement.git
|
|
```
|
|
|
|
Check that everything works by running
|
|
```
|
|
linemeasurement --version
|
|
```
|
|
|
|
To uninstall, run
|
|
```sh
|
|
uv tool uninstall linemeasurement
|
|
```
|
|
|
|
# Usage
|
|
|
|
Run the app with the command:
|
|
```sh
|
|
linemeasurement
|
|
```
|
|
|
|
Run `linemeasurement --help` to see available options.
|
|
|
|
# Interface
|
|
|
|
Up top, you will find the parameter list. Each parameter has a couple elements. From left to right:
|
|
- The name of the parameter.
|
|
- 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 and drag to move around.
|
|
- Right-click and drag to zoom.
|
|
- Scroll wheel to zoom.
|
|
- 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.
|
|
- To hide/show a line, click on it in the legend. You can also click and drag the legend to move it around.
|
|
- Click and drag between two plots to resize them.
|
|
- 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.
|
|
|
|
|