-
Notifications
You must be signed in to change notification settings - Fork 134
Gsoc2024 rebased autoplot #2547
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 7 commits
Commits
Show all changes
18 commits
Select commit
Hold shift + click to select a range
d1f8382
GUI for Automated plotting (#2414)
Preetam-Das26 9f3f69f
GUI FOR AUTOMATED PLOTTING 2- update the GUI (#2464)
Preetam-Das26 c9d1233
removed hard coded predefined_map_section (#2550)
ReimarBauer d79733b
Autoplot namings fixed (#2548)
ReimarBauer 73035ac
old defaults for old versions, undo changes (#2549)
ReimarBauer eee46f1
autoplot: undo removinvg show release_info (#2552)
ReimarBauer 342d317
COMMIT fixes immediate update in side/linear view (#2553)
Preetam-Das26 9082188
Autoplot replace QtTest calls in msui mainwindow (#2551)
ReimarBauer 446eb8f
Autoplot - solving the parent problem in topview, linearview, sidevie…
ReimarBauer 26c90b7
reorder imports in autoplot_dockwidget (#2555)
Preetam-Das26 ba47b36
added autoplot docs (#2558)
ReimarBauer 3f5f546
Autoplot has to use http auth for mscolab and login (#2556)
ReimarBauer 23120a8
Autoplot - Add messagebox for emptytreewidget (#2562)
Preetam-Das26 cdfd89a
autoplot -replace sys.exit by raise SystemExit and catch it (#2561)
ReimarBauer d0b1bad
fix login (#2569)
ReimarBauer a2e4f5e
Autoplot - Enable mssautoplot for side and linearviews (#2563)
Preetam-Das26 e3ebe01
Autoplot mscolab for sideview (#2573)
ReimarBauer 0eee85d
enabled mscolab for linearview and linearview (#2574)
ReimarBauer File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,97 @@ | ||
| GUI FOR AUTOMATED PLOTTING | ||
| ========================== | ||
|
|
||
| Autoplot Docking Widget | ||
| ----------------------- | ||
|
|
||
| **Autoplot Dockwidget Description:** | ||
| The Docking Widget offers users a Graphical User Interface (GUI) for downloading plots based on specified configurations. It provides a user-friendly approach, integrating seamlessly with other dock widgets. This widget can be accessed across all three views—Top View, Side View, and Linear View—ensuring flexibility and ease of use for different user preferences. | ||
|
|
||
| **Components:** | ||
|
|
||
| The autoplot docking widget contains the following parameters which can be configured: | ||
|
|
||
| - **Select configuration file button**: This button is used to select the JSON file for uploading the configurations to the dock widget. By default, it uses the `mssautoplot.json` file located in this path - `$HOME/.config/msui`. | ||
|
|
||
| - **Left Treewidget**: The following parameters can be configured or updated based on requirements: | ||
|
|
||
| - Flight | ||
| - Map Sections | ||
| - Vertical | ||
| - Filename | ||
| - Initial Time | ||
| - Valid Time | ||
|
|
||
| - **Right Treewidget**: The following parameters can be configured or updated: | ||
|
|
||
| - URL | ||
| - Layers | ||
| - Styles | ||
| - Level | ||
| - Start Time | ||
| - End Time | ||
| - Time Interval | ||
|
|
||
| - **ComboBoxes**: These allow configuring the start time, end time, and time interval. Ensure that the start time is always less than the end time. The plots are downloaded from the start time to the end time at the provided time intervals. | ||
|
|
||
| - **Download Plots Button**: This button is used to download plots based on the configurations. The configuration is saved in the `mssautoplot.json` file by default, located at `$HOME/.config/msui`. | ||
|
|
||
| - **Update/Create JSON file**: This button will create or update the JSON file. If not present, it will update the default `mssautoplot.json` file located at `$HOME/.config/msui`. | ||
|
|
||
| How to Use | ||
| ---------- | ||
|
|
||
| The `mssautoplot.json` file located in the `$HOME/.config/msui` directory contains the default configuration. | ||
|
|
||
| The **left treewidget** is used to configure the automated plotting flights list: | ||
|
|
||
| .. code-block:: json | ||
|
|
||
| "automated_plotting_flights": | ||
| [ | ||
| ["flight1", "section1", "vertical1", "filename1", "init_time1", "time1"], | ||
| ["flight2", "section2", "vertical2", "filename2", "init_time2", "time2"] | ||
| ] | ||
|
|
||
| - Flight, filename, and section parameters are configured in the **Top View**. | ||
| - The vertical parameter is configured in the **Side View**. | ||
|
|
||
| The **right treewidget** is used to configure the automated plotting flight sections, which are based on the view: | ||
|
|
||
| - For **Top View**, it is `"automated_plotting_hsecs": [["URL", "Layer", "Styles", "Level"]]`. | ||
| - For **Side View**, it is `"automated_plotting_vsecs": [["URL", "Layer", "Styles", "Level"]]`. | ||
| - For **Linear View**, it is `"automated_plotting_lsecs": [["URL", "Layer", "Styles"]]`. | ||
|
|
||
| Inserting, Updating, and Removing Configuration in the Treewidget | ||
| ----------------------------------------------------------------- | ||
|
|
||
| There are three buttons— **Add**, **Update**, and **Remove**—under each treewidget: | ||
|
|
||
| - **Add Button**: Inserts a row based on the current configurations. | ||
|
|
||
| - For the left treewidget, the current values of flight, section, vertical, filename, init_time, and time are inserted. | ||
| - For the right treewidget, the current values of URL, Layers, Styles, Level, Start Time, End Time, and Time Interval are inserted. | ||
|
|
||
| - **Remove Button**: Removes the selected row. | ||
|
|
||
| - **Update Button**: Updates the selected row with the current values (only active after selecting a row). | ||
|
|
||
| Ensure that the **right tree widget** has at least one row before inserting into the left treewidget. | ||
|
|
||
| Downloading the Plots | ||
| --------------------- | ||
|
|
||
| Plots can be downloaded in the following ways: | ||
|
|
||
| 1. Upload the configuration JSON file by clicking the **Select configuration file** button, then click the **Download Plots** button to download the plots. | ||
| 2. Upload the configuration JSON file by clicking the **Select configuration file** button, then make modifications as needed. | ||
| 3. Download plots with or without flight track from start time to end time at specified time intervals. This ensures that a total of `M x N` plots are downloaded, where `M` is the number of rows in the left treewidget and `N` is the number of rows in the right treewidget. | ||
|
|
||
| Example | ||
| ------- | ||
|
|
||
| An `mssautoplot.json` file generated after clicking the **Update/Create Configuration file Button** in the path, e.g. “$HOME/.config/msui” by default: | ||
|
|
||
| **/$HOME/.config/msui/mssautoplot.json** | ||
|
|
||
| .. literalinclude:: samples/config/msui/autoplot_dockwidget.json.sample | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.